跳到主要内容

贡献指南

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) 测试。