简单介绍下 git commit 的规范。

我们每次进行 git 提交的时候,git commit 都包括三个部分:

  • header
  • body
  • footer

header 是必须的,body 和 footer 经常可以省略


header 部分就只有一行(不超过 72 个字符), 包括三个字段type(必须),scope(可选),subject(必须)

1
<type>(<scope>): <subject>
  • type:
1
2
3
4
5
6
7
8
9
10
feat:    增加新功能(feature)
fix: 修补bug
docs: 仅仅修改了文档,比如说README,CHANGELOG等等
style: 修改了空格,格式缩进,样式格式(不改变代码逻辑的变动)
refactor:重构(即不是新增功能,也不是修改bug的代码变动)
test: 增加测试,包括单元测试等
perf: 优化相关,比如提升了性能,体验等
chore: 构建过程或辅助工具的变动
revert: 回滚到上一个版本
build: Build System | 构建
  • scope:
    scope 用作说明 commit 的影响范围。
  • subject:
    subject 是对 commit 的简短说明。
1
2
3
以动词开头
第一个字母小写
结尾没有句号