贡献指南

上下同欲者胜, 风雨同舟者兴. --孙武

本项目是一个开源项目, 我们鼓励社区成员参与改进.

开发流程

1. 分支划分:
   • main 分支: 稳定版本
   • dev 分支: 开发版本
   • 功能分支: 从 dev 分支创建, 命名格式为 feature/描述 或 fix/描述 或 refactor/描述
2. 代码风格:
   • 请使用 Black 格式化代码
   • 遵循 PEP 8 规范
   • 添加适当的文档字符串
3. 提交消息:
   • 使用简体中文或英文撰写清晰的提交消息
   • 格式: 遵循 Conventional Commits 规范

设置开发环境

# 克隆仓库
git clone https://gitea.imwangzhiyu.xyz/ajax/HeurAMS

cd HeurAMS

# 你可能需要切换分支

# 安装依赖
pip install -r requirements.txt

# 安装开发版本
pip install -e .

提交 Pull Request

1. 创建功能分支

   git checkout -b feature/your-feature-name

2. 开发并测试

   • 编写代码
   • 添加测试用例
   • 确保所有测试通过

3. 提交代码

   git add .
   git commit -m "feat(module): your feature description"
   git push origin feature/your-feature-name

4. 创建 Pull Request

   • 在代码托管平台创建 PR
   • 填写详细的描述
   • 关联相关 Issue

报告问题

Bug 报告

当报告 Bug 时, 请提供：

• 问题描述 - 详细的问题描述
• 重现步骤 - 如何重现问题
• 环境信息 - 操作系统、Python 版本等
• 日志信息 - 相关的错误日志

功能请求

当提出功能请求时, 请提供：

• 功能描述 - 详细的功能描述
• 使用场景 - 功能的使用场景
• 实现建议 - 可能的实现方式

许可证

贡献者同意其贡献将在 AGPL-3.0 许可证下发布.