Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (33 loc) · 1023 Bytes

CONTRIBUTING.md

File metadata and controls

43 lines (33 loc) · 1023 Bytes
Raw

贡献指南

感谢您对 AutoRAG 系统的关注！

如何贡献

报告问题

如果您发现了 bug 或有功能建议，请在 GitHub 上创建 issue。

提交代码

  1. Fork 本仓库
  2. 创建您的特性分支 (git checkout -b feature/AmazingFeature)
  3. 提交您的更改 (git commit -m 'Add some AmazingFeature')
  4. 推送到分支 (git push origin feature/AmazingFeature)
  5. 开启一个 Pull Request

开发规范

代码风格

  • 遵循 PEP 8 规范
  • 使用有意义的变量和函数名
  • 添加必要的注释

提交信息

  • 使用清晰的提交信息
  • 格式：type: description
    • feat: 新功能
    • fix: 修复 bug
    • docs: 文档更新
    • style: 代码格式调整
    • refactor: 代码重构
    • test: 测试相关
    • chore: 构建/工具相关

测试

  • 确保代码通过现有测试
  • 为新功能添加测试用例

联系方式