跳到主要内容

贡献指南

RAGFlow 社区贡献者的通用指导原则。

本文档提供了提交您贡献给 RAGFlow 的指南和主要考虑事项。

  • 若要报告一个 Bug，请通过 GitHub issue 提交。
  • 对于进一步的问题，您可以查看现有的讨论或在 Discussions 中发起一个新的主题。

您可以贡献的内容​

以下是一些您可以做出的贡献，但并不全面：

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

创建拉取请求（PR）​

通用工作流程​

  1. 叉我们的 GitHub 仓库。
  2. 将您的叉到本地机器： git clone [email protected]:<yourname>/ragflow.git
  3. 在本地创建一个分支： git checkout -b my-branch
  4. 提供足够的信息在提交消息中 git commit -m '提供足够的提交信息'
  5. 将更改提交到您的本地分支，并推送到 GitHub：（包括必要的提交消息） git push origin my-branch。
  6. 提交一个拉取请求以供审查。

在创建 PR 之前​

  • 考虑将大的 PR 分成多个小的独立的 PR，以便保持可追溯的发展历史。
  • 确保您的 PR 只解决一个问题，或者尽量减少无关的更改。
  • 当贡献新功能时，请添加测试用例。它们表明您的代码可以正常工作，并且有助于防止未来变更中可能出现的问题。

描述您的 PR​

  • 确保您的 PR 标题简洁明了，提供所需的所有信息。
  • 如果适用，在您的 PR 说明中引用相关的 GitHub issue。
  • 对于 破坏性变更 或 API 变更 在描述中包含足够的设计细节。

审查与合并 PR​

确保在合并之前通过所有持续集成（CI）测试。