遵循清晰的提交规范能显著提升团队协作效率,以下是核心原则:
1. 提交信息格式 📝
- 类型(Type):使用
feat
(功能)、fix
(修复)、docs
(文档)、style
(格式)、refactor
(重构)、perf
(性能)、test
(测试)等关键词 - 主题(Subject):简洁描述变更内容,如
Add user_profile route
或Fix bug in login validation
- 正文(Body):可选补充说明,保持空行分隔(如需)
💡 示例:
docs: Update contribution guidelines link
提交信息需通过 提交规范验证工具 自动校验
2. 分支管理 🌐
- 主分支:
main
(稳定版本) - 开发分支:
dev
(当前开发版本) - 功能分支:
feature/xxx
(具体功能名称) - 修复分支:
fix/xxx
(问题描述)
3. 常见规范 📌
- 小写:提交类型和主题均使用小写
- 动词开头:如
fix
,add
,remove
- 避免特殊符号:仅使用
-
分隔,如feat - implement dark_mode
4. 扩展阅读 📚
🚫 请勿提交包含敏感信息或不合规内容的提交记录