Skip to content

Latest commit

 

History

History
154 lines (109 loc) · 3.81 KB

File metadata and controls

154 lines (109 loc) · 3.81 KB

贡献指南

感谢您对多Agent智能分流与长程记忆优化系统的关注!我们欢迎任何形式的贡献,包括但不限于代码提交、问题报告、功能建议等。本指南将帮助您了解如何参与项目开发。

目录

行为准则

本项目采用贡献者公约,请所有参与者遵守。

如何贡献

报告Bug

如果您发现了Bug,请通过GitHub Issues报告,并确保:

  1. 使用清晰的标题描述问题
  2. 详细描述复现步骤
  3. 提供环境信息(操作系统、Python版本等)
  4. 如可能,附上截图或日志
  5. 使用Bug报告模板(.github/ISSUE_TEMPLATE/bug_report.md)

提出新功能

如果您有新功能建议,请:

  1. 检查现有Issues,避免重复
  2. 创建新Issue,使用功能请求模板
  3. 清晰描述功能及其解决的问题
  4. 如可能,提供实现思路或伪代码

提交代码

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

开发流程

分支管理

  • main: 主分支,保持稳定可发布状态
  • develop: 开发分支,最新开发进展
  • feature/*: 特性分支,用于开发新功能
  • bugfix/*: 修复分支,用于修复Bug
  • release/*: 发布分支,准备新版本发布

提交信息规范

请使用以下格式提交代码:

<类型>(<范围>): <描述>

[可选的详细描述]

[可选的相关Issue]

类型包括:

  • feat: 新功能
  • fix: Bug修复
  • docs: 文档更新
  • style: 代码风格调整(不影响功能)
  • refactor: 代码重构
  • perf: 性能优化
  • test: 测试相关
  • chore: 构建过程或辅助工具变动

代码风格

  • 遵循PEP 8规范
  • 使用4个空格缩进
  • 使用有意义的变量名和函数名
  • 添加必要的注释和文档字符串
  • 使用类型提示

测试

  • 为新功能编写单元测试
  • 确保所有测试通过:pytest
  • 尽量保持或提高代码覆盖率

文档

  • 更新相关文档以反映您的更改
  • 为新功能添加使用示例
  • 保持文档风格一致性

联系方式

如有任何问题,请联系项目维护者:

  • 项目维护者:[您的姓名]
  • 邮箱:[您的邮箱]
  • GitHub:@your-username

如果您在使用过程中发现了问题,请在GitHub上提交Issue,并提供以下信息:

  1. 问题描述
  2. 复现步骤
  3. 预期结果
  4. 实际结果
  5. 环境信息(操作系统、Python版本等)

提交代码

  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代码规范
  • 添加适当的注释和文档字符串
  • 确保所有测试通过
  • 添加新的测试用例(如适用)

📚 文档贡献

您也可以通过完善文档来贡献项目:

  • 修复文档中的错别字或语法错误
  • 补充使用示例
  • 翻译文档
  • 编写教程

🧪 测试

在提交代码之前,请确保:

  1. 所有现有测试通过
  2. 添加了新的测试用例(如适用)
  3. 测试覆盖率没有下降

📄 许可证

通过贡献代码,您同意您的贡献将遵循项目的MIT许可证。