1.3 KiB
1.3 KiB
贡献指南
感谢您有兴趣为本项目做贡献!在提交您的贡献之前,请务必花点时间阅读以下指南。
行为准则
本项目遵守行为准则。通过参与,您需要遵守该准则。请报告不可接受的行为到维护者。
如何贡献
提交 Issue
- 在提交 issue 之前,请先搜索现有 issue,避免重复
- 选择合适的 issue 模板(Bug 报告或功能请求)
- 清晰准确地描述问题或需求
提交代码
- Fork 项目并创建您的分支 (
git checkout -b feature/AmazingFeature) - 提交您的更改 (
git commit -m 'Add some AmazingFeature') - 推送到分支 (
git push origin feature/AmazingFeature) - 开启 Pull Request
代码规范
- 遵循项目现有的代码风格
- 添加适当的注释说明复杂逻辑
- 编写测试用例(如果适用)
- 确保所有测试通过
Pull Request 规范
- 保持 PR 聚焦于单一功能或修复
- 在 PR 描述中清楚解释变更的目的和影响
- 关联相关的 issue(如果有的话)
- 确保 CI 检查通过
代码审查流程
所有提交的 PR 都会经过审查过程:
- 自动化检查(CI)
- 维护者人工审查
- 根据反馈进行修改
- 合并到主分支
感谢您的贡献!