跳到主要内容

贡献指南 (Contribution guidelines)

面向 RAGFlow 社区贡献者的通用指南。

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

  • 要报告错误（Bug），请向我们提交 GitHub Issue。
  • 如有更多疑问，您可以在 GitHub Discussions 中浏览已有的讨论或发起新的讨论。

您可以贡献什么

下面的列表列出了您可以做出的一些贡献，但不仅限于此：

  • 提出或实现新功能
  • 修复错误（Bug）
  • 添加测试用例或 Demo
  • 发表博客或教程
  • 更新现有文档、代码或批注
  • 建议更人性化的错误码

提交合并请求 (Pull Request, PR)

通用工作流程

  1. Fork 我们的 GitHub 仓库。
  2. 将您的 Fork 仓库克隆到您的本地机器： 
    git clone git@github.com:<yourname>/ragflow.git
  3. 创建本地分支： 
    git checkout -b my-branch
  4. 在 Commit 提交信息中提供足够的信息。
  5. 将更改提交到您的本地分支，并推送到 GitHub（包含必要的提交信息）： 
    git push origin my-branch
  6. 提交 Pull Request 以供评审（Review）。

提交 PR 之前

  • 考虑将大型 PR 拆分为多个较小的、独立的 PR，以保持开发历史的可追溯性。
  • 确保您的 PR 只解决一个问题，或使不相关的更改保持在极小范围内。
  • 在贡献新功能时，请添加测试用例。这能证明您的代码能够正常工作，并防止未来的代码变更引发潜在问题。

描述您的 PR

  • 确保您的 PR 标题简洁清晰，提供所有必需的信息。
  • 如果适用，请在 PR 描述中引用对应的 GitHub Issue。
  • 如果涉及不兼容性变更（breaking changes）或API 变更，请在描述中包含足够的设计细节。

评审与合并 PR

  • 确保您的 PR 在合并前通过了所有持续集成（CI）测试。