贡献指南
RAGFlow 社区贡献者通用指南。
本文档为向 RAGFlow 提交贡献提供了指导和主要注意事项。
- 要报告错误，请向我们提交 GitHub issue。
- 如有其他问题，您可以在 Discussions 中浏览现有讨论或发起新的讨论。
您可以贡献什么
以下列表列出了一些您可以做的贡献，但并非详尽无遗。
- 提出或实现新功能
- 修复错误
- 添加测试用例或演示
- 发布博客或教程
- 更新现有文档、代码或注释
- 建议更友好的错误代码
提交拉取请求（PR）
通用工作流程
- Fork 我们的 GitHub 仓库。
- 将您的 fork 克隆到本地计算机：
git clone git@github.com:<yourname>/ragflow.git - 创建一个本地分支：
git checkout -b my-branch - 在您的提交信息中提供足够的信息：
git commit -m '在您的提交信息中提供足够的信息' - 将更改提交到您的本地分支，并推送到 GitHub：（包括必要的提交信息）
git push origin my-branch. - 提交拉取请求以供审查。
提交 PR 之前
- 考虑将一个大的 PR 拆分成多个较小的、独立的 PR，以保持可追溯的开发历史。
- 确保您的 PR 只解决一个问题，或者将任何不相关的更改保持在最小范围。
- 在贡献新功能时添加测试用例。它们能证明您的代码功能正常，并防止未来更改可能导致的问题。
描述您的 PR
- 确保您的 PR 标题简洁明了，并提供所有必需的信息。
- 如果适用，在您的 PR 描述中引用相应的 GitHub issue。
- 在您的描述中为重大变更或 API 变更提供足够的设计细节。
审查和合并 PR
在合并 PR 之前，请确保它通过了所有的持续集成（CI）测试。