Wang Zhiyu
035f4c1190
完成 0.4.0 版本更新, 为了消除此前提交消息风格不一致与错误提交超大文件的问题, 维持代码统计数据的准确性和提交消息风格的一致性, 重新初始化仓库; 旧的提交历史在 HeurAMS-legacy 仓库(https://gitea.imwangzhiyu.xyz/ajax/HeurAMS-legacy) BREAKING CHANGE: 略
45 lines
1.1 KiB
Markdown
45 lines
1.1 KiB
Markdown
# 贡献指南
|
|
|
|
欢迎为此项目做出贡献!
|
|
本项目是一个开源项目, 我们鼓励社区成员参与改进.
|
|
|
|
## 开发流程
|
|
|
|
1. **分支划分**:
|
|
- `main` 分支: 稳定版本
|
|
- `develop` 分支: 开发版本
|
|
- 功能分支: 从 `develop` 分支创建, 命名格式为 `feature/描述` 或 `fix/描述`
|
|
2. **代码风格**:
|
|
- 请使用 Black 格式化代码
|
|
- 遵循 PEP 8 规范
|
|
- 添加适当的文档字符串
|
|
3. **提交消息**:
|
|
- 使用中文或英文撰写清晰的提交消息
|
|
- 格式: `类型: 描述`, 例如 `fix: 修复登录错误` 或 `feat: 添加新算法`
|
|
4. **测试**:
|
|
- 为新功能添加单元测试
|
|
- 确保所有测试通过
|
|
- 运行 `pytest` 检查
|
|
|
|
## 项目结构
|
|
|
|
请参阅 README.md 中的项目结构部分, 了解代码组织方式.
|
|
|
|
## 设置开发环境
|
|
|
|
```bash
|
|
# 克隆仓库
|
|
git clone https://github.com/yourusername/HeurAMS.git
|
|
cd HeurAMS
|
|
|
|
# 安装依赖
|
|
pip install -r requirements.txt
|
|
|
|
# 安装开发版本
|
|
pip install -e .
|
|
```
|
|
|
|
## 许可证
|
|
|
|
贡献者同意其贡献将在 AGPL-3.0 许可证下发布.
|