跳到主要内容
版本: DEV

贡献指南

RAGFlow 社区贡献者通用指南。

本文档提供了向 RAGFlow 提交贡献的指南和主要注意事项。

  • 要报告错误，请在 GitHub 上提交一个 issue。
  • 如有其他问题，您可以在 Discussions 中浏览现有讨论或发起新讨论。

您可以贡献什么​

以下列表列出了一些您可以进行的贡献，但这并非完整列表。

  • 提出或实现新功能
  • 修复错误
  • 添加测试用例或演示
  • 发表博客或教程
  • 更新现有文档、代码或注释。
  • 建议更友好的错误码

提交拉取请求 (PR)​

通用工作流程​

  1. Fork 我们的 GitHub 仓库。
  2. 将你的 fork 克隆到本地机器：git clone git@github.com:<yourname>/ragflow.git
  3. 创建本地分支：git checkout -b my-branch
  4. 在你的提交信息中提供足够的信息 git commit -m 'Provide sufficient info in your commit message'
  5. 将更改提交到你的本地分支，并推送到 GitHub：（包含必要的提交信息）git push origin my-branch.
  6. 提交拉取请求以供评审。

提交 PR 之前​

  • 考虑将大型 PR 拆分为多个更小、独立的 PR，以便保持可追踪的开发历史。
  • 确保你的 PR 只解决一个问题，或者让任何不相关的更改保持很小。
  • 贡献新功能时请添加测试用例。它们能证明你的代码功能正常，并防范未来更改可能带来的问题。

描述你的 PR​

  • 确保你的 PR 标题简洁明了，并提供所有必要信息。
  • 如果适用，在你的 PR 描述中引用相应的 GitHub issue。
  • 在你的描述中包含针对破坏性更改或API 更改的足够设计细节。

评审与合并 PR​

合并 PR 之前，确保它通过所有持续集成 (CI) 测试。