核心原则
- ✅ 清晰描述变更:提交信息需简洁说明代码改动的目的(如
feat: 添加用户登录功能
) - 📜 遵循原子提交:每个提交应只包含一个逻辑上的变更单元
- 🔄 分支命名规范:使用
feature/xxx
、hotfix/xxx
等标准前缀(了解更多分支策略)
常用提交类型
类型 | 用途 | 示例 |
---|---|---|
feat |
新增功能 | feat: 优化性能监控模块 |
fix |
修复bug | fix: 修复登录接口404错误 |
docs |
文档更新 | docs: 更新README使用说明 |
style |
代码格式 | style: 统一变量命名格式 |
refactor |
重构代码 | refactor: 重写数据处理逻辑 |
提交信息格式
- 首行简明:使用动词+名词结构(如
优化API响应时间
) - 正文补充:可添加详细说明(如
增加缓存机制减少数据库查询
) - 关联Issue:结尾注明相关问题编号(如
Fixes #123
)
工具推荐
- 📌 Conventional Commits 标准参考
- 🧰 Commitizen 交互式提交工具(本站链接)
- 📈 GitStats 生成提交统计图表