git commit message (AngularJS)格式

commit message格式:

<type>[<scope>]: <subject>
// 空一行
<body>
// 空一行
<footer>

type用于说明 commit 的类别,只允许使用下面7个标识。
  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • pref:优化
  • test:增加测试
  • chore:构建过程或辅助工具的变动
  • revert:撤销以前的commit
如果type为featfix,则该 commit 将肯定出现在 Change log 之中。
scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。
subject是 commit 目的的简短描述,不超过50个字符。
  • 动词开头,使用第一人称现在时,比如change,而不是changed或changes
  • 第一个字母小写
  • 结尾不加句号(.)


body
(1)使用第一人称现在时,比如使用change而不是changed或changes。
(2)应该说明代码变动的动机,以及与以前行为的对比。
footer描述不兼容变动和关闭issue

还有一种特殊情况,如果当前 commit 用于撤销以前的 commit,则必须以revert:开头,后面跟着被撤销 Commit 的 Header。

规范化提交 commit 工具:
npm install -g commitizen

commitizen init cz-conventional-changelog --save --save-exact
git commit 改用 git cz