为什么要规定提交规范

团队协作开发时,每个人提交都会编写自己的commit message.

如果不加以规范,最终项目就会杂乱不堪,难以管理.

一般的大厂,大型开源项目的commit message格式是非常一致的,便于管理,提高效率.

Git提交规范

commitizen规范

该规范有3个部分:

1
2
3
4
5
<type>(<scope>): subject
// 空行
<body>
// 空行
<footer>

后两部分可以省略.

type

必须,用于说明类型,有如下类型.

  • feat: 新功能
  • fix: 修复bug
  • docs: 文档改变
  • style: 代码格式改变
  • refactor: 某个已有功能重构
  • perf: 性能优化
  • test: 增加测试
  • build: 构建工具或外部依赖包的修改
  • revert: 撤销上一次的 commit
  • chore: 构建过程或辅助工具的变动

scope

可选,用于说明影响的范围,比如数据层、控制层、视图层等.

subject

必须,简短描述,不超过50字符.

body

可选,对subject的补充,可以多行.

可选,关联issue