1.5 KiB
1.5 KiB
贡献指南
感谢你考虑为 {{PROJECT_NAME}} 做贡献！
贡献方式
- 报告 Bug
- 提交功能建议
- 改进文档
- 提交代码 PR
开发环境
环境要求
{{DEV_REQUIREMENTS}}
环境搭建
# 克隆仓库
git clone {{REPO_URL}}
cd {{PROJECT_DIR}}
# 安装依赖
{{INSTALL_DEPS}}
# 运行测试
{{RUN_TESTS}}
代码规范
{{CODE_STYLE}}
提交信息格式
<type>(<scope>): <subject>
<body>
<footer>
type 类型：
feat: 新功能fix: 修复 Bugdocs: 文档更新style: 代码格式refactor: 重构test: 测试相关chore: 构建/工具
提交 PR
- Fork 本仓库
- 创建特性分支：
git checkout -b feature/your-feature - 提交更改：
git commit -m 'feat: add some feature' - 推送分支：
git push origin feature/your-feature - 创建 Pull Request
PR 检查清单
- 代码通过所有测试
- 新功能有对应测试
- 更新了相关文档
- 提交信息格式正确
代码审查
所有 PR 都需要至少一位维护者审查后才能合并。
行为准则
请阅读并遵守我们的 行为准则。
联系方式
- 问题讨论：GitHub Discussions
- Bug 报告：GitHub Issues