Aofei Sheng

Git 的 Commit Message 和 Change Log 编写指南

Git 每次提交代码,都要写 Commit Message(提交说明),否则就不允许提交。

$ git commit -m "hello world"

上面代码的 -m 参数,就是用来指定 Commit Mesage 的。

如果一行不够,可以只执行 git commit,就会跳出文本编辑器,让你写多行。

$ git commit

基本上,你写什么都行(这里这里这里)。

但是,一般来说,Commit Message 应该清晰明了,说明本次提交的目的。

目前,社区有多种 Commit Message 的写法规范。本文介绍 Angular 规范(见上图),这是目前使用最广的写法,比较合理和系统化,并且有配套的工具。

一、Commit Message 的作用

格式化的 Commit Message,有几个好处。

(1)提供更多的历史信息,方便快速浏览。

比如,下面的命令显示上次发布后的变动,每个 Commit 占据一行。你只看行首,就知道某次 Commit 的目的。

$ git log <last tag> HEAD --pretty=format:%s

(2)可以过滤某些 Commit(比如文档改动),便于快速查找信息。

比如,下面的命令仅仅显示本次发布新增加的功能。

$ git log <last release> HEAD --grep feature

(3)可以直接从 Commit 生成 Change Log。

Change Log 是发布新版本时,用来说明与上一个版本差异的文档,详见后文。

二、Commit Message 的格式

每次提交,Commit Message 都包括三个部分:Header,Body 和 Footer。

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

其中,Header 是必需的,Body 和 Footer 可以省略。

不管是哪一个部分,任何一行都不得超过 72 个字符(或 100 个字符)。这是为了避免自动换行影响美观。

2.1 Header

Header 部分只有一行,包括三个字段:type(必需)、scope(可选)和 subject(必需)。

(1)type

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

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

如果 typefeatfix,则该 Commit 将肯定出现在 Change Log 之中。其他情况由你决定要不要放入 Change Log,建议是不要。

(2)scope

scope 用于说明 Commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

(3)subject

subject 是 Commit 目的的简短描述,不超过 50 个字符。

以动词开头,使用第一人称现在时,比如 change,而不是 changed 或 changes
第一个字母小写
结尾不加句号(.)

2.2 Body

Body 部分是对本次 Commit 的详细描述,可以分成多行。下面是一个范例。

More detailed explanatory text, if necessary.  Wrap it to
about 72 characters or so.

Further paragraphs come after blank lines.

- Bullet points are okay, too
- Use a hanging indent

有两个注意点。

(1)使用第一人称现在时,比如使用 change 而不是 changedchanges

(2)应该说明代码变动的动机,以及与以前行为的对比。

2.3 Footer

Footer 部分只用于两种情况。

(1)不兼容变动

如果当前代码与上一个版本不兼容,则 Footer 部分以 BREAKING CHANGE 开头,后面是对变动的描述、以及变动理由和迁移方法。

BREAKING CHANGE: isolate scope bindings definition has changed.

    To migrate the code follow the example below:

    Before:

    scope: {
      myAttr: 'attribute',
    }

    After:

    scope: {
      myAttr: '@',
    }

    The removed `inject` wasn't generaly useful for directives so there should be no code using it.

(2)关闭 Issue

如果当前 Commit 针对某个 Issue,那么可以在 Footer 部分关闭这个 Issue 。

Closes #234

也可以一次关闭多个 Issue。

Closes #123, #245, #992

2.4 Revert

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

revert: feat(pencil): add 'graphiteWidth' option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

Body 部分的格式是固定的,必须写成 This reverts commit <hash>.,其中的 hash 是被撤销 Commit 的 SHA 标识符。

如果当前 Commit 与被撤销的 Commit,在同一个发布(Release)里面,那么它们都不会出现在 Change Log 里面。如果两者在不同的发布,那么当前 Commit,会出现在 Change Log 的 Reverts 小标题下面。

三、Commitizen

Commitizen 是一个撰写合格 Commit Message 的工具。

安装命令如下。

$ npm install -g commitizen

然后,在项目目录里,运行下面的命令,使其支持 Angular 的 Commit Message 格式。

$ commitizen init cz-conventional-changelog --save --save-exact

以后,凡是用到 git commit 命令,一律改为使用 git cz。这时,就会出现选项,用来生成符合格式的 Commit Message。

四、validate-commit-msg

validate-commit-msg 用于检查 Node 项目的 Commit Message 是否符合格式。

它的安装是手动的。首先,拷贝下面这个 JS 文件,放入你的代码库。文件名可以取为 validate-commit-msg.js

接着,把这个脚本加入 Git 的 Hook。下面是在 package.json 里面使用 ghooks,把这个脚本加为 commit-msg 时运行。

{
  "config": {
    "ghooks": {
      "commit-msg": "./validate-commit-msg.js"
    }
  }
}

然后,每次 git commit 的时候,这个脚本就会自动检查 Commit Message 是否合格。如果不合格,就会报错。

$ git add -A
$ git commit -m "edit markdown"
INVALID COMMIT MSG: does not match "<type>(<scope>): <subject>" ! was: edit markdown

五、生成 Change Log

如果你的所有 Commit 都符合 Angular 格式,那么发布新版本时,Change Log 就可以用脚本自动生成(例 1例 2例 3)。

生成的文档包括以下三个部分。

New features.
Bug fixes.
Breaking changes.

每个部分都会罗列相关的 Commit ,并且有指向这些 Commit 的链接。当然,生成的文档允许手动修改,所以发布前,你还可以添加其他内容。

conventional-changelog 就是生成 Change Log 的工具,运行下面的命令即可。

$ npm install -g conventional-changelog
$ cd my-project
$ conventional-changelog -p angular -i CHANGELOG.md -w

上面命令不会覆盖以前的 Change Log,只会在 CHANGELOG.md 的头部加上自从上次发布以来的变动。

如果你想生成所有发布的 Change Log,要改为运行下面的命令。

$ conventional-changelog -p angular -i CHANGELOG.md -w -r 0

为了方便使用,可以将其写入 package.jsonscripts 字段。

{
  "scripts": {
    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0"
  }
}

以后,直接运行下面的命令即可。

$ npm run changelog

(转自:阮一峰的网络日志