开发者经常会从git commit提交内容识别代码修改的内容,从而更好地进行代码的维护,一个不友好的提交规范会让代码维护者欲哭无泪,所以良好的代码提交规范是必要的。

Commit message格式

<type>(<scope>): <subject>

注意冒号后面有空格。

type

用于说明 commit 的类别,只允许使用下面7个标识。

  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • test:增加测试
  • chore:构建过程或辅助工具的变动

如果type为featfix,则该 commit 将肯定出现在 Change log 之中。

scope

选填,表示commit的作用范围,如数据层、视图层,也可以是目录名称。

subject

subject是 commit 目的的简短描述,不超过50个字符,且结尾不加句号(.)。

工具

我们可以通过工具来规范我们的提交。

先来安装一下工具:

npm install -g commitizen

接下来,可以使用git cz命令来代替git commit完成提交动作。

另外,如果你还需要给你的提交加上表情,那么你可以继续安装另一个包:

npm install -g emoji-cz

接着,执行如下命令以向~/.czrc文件中添加内容:

echo '{ "path": "emoji-cz" }' > ~/.czrc

此时,当我们执行git cz命令,我们就可以看到有趣的提交表情啦!

拓展

git commit 规范工具(又是一篇华而不实的文章).