Commit message 和 Change log 编写指南

作者: 阮一峰

日期: 2016年1月 6日

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 之中。其他情况(docschorestylerefactortest)由你决定,要不要放入 Change log,建议是不要。

(2)scope

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

(3)subject

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

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

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 &lt;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

(完)

珠峰培训

简寻

留言(31条)

昨天睡前还在想怎么从commit生成changelog,阮老师这篇文章真是太及时了

据说github能够识别CommitMsg里的一些动词,自动触发一些动作,请阮老师也一并讲讲吧。

不多评论!有用!

changelog 之前用 tj/git-extras

阮老师这篇应该还缺一个知识点: git release 相关.

哪有时间写那么详细的commit message 还干活不

docs:文档(documentation)提交标识是什么意思?指的是项目中的非代码文件的改动??

好细致

过于复杂了。如果是给开发者看的Changelog,直接看提交信息也可;如果是给用户看的,就不该自动生成。

真不错!

commitizen为什么一定要做成引入package. json…………非js的项目也强制引入的做法也太不科学了……

JS程序员眼里世上只有一种编程语言么……

这篇文章真的很棒,一直不知道如何规范提交记录,项目的提交记录现在一团糟,看见这篇文章顿时茅塞顿开!赞一个!!!

想问阮老师一个问题,如果用了Commitizen后,每次commit都是有标准格式了, validate-commit-msg这个工具应该再怎么配合使用?

引用CodingNinja的发言:

docs:文档(documentation)提交标识是什么意思?指的是项目中的非代码文件的改动??

我的理解跟你的应该一样,比如 Readme.md 这种项目说明文档类的修改。

太赞了!这个很不错!

非node项目貌似不能支持?

日常开发commit怎么写……感觉也没写完啥功能或模块,只是想在git上备份一下

有win下的gui工具能实现严格过滤commit格式吗

这些commit changelog内容很好,但怎么样应用于一个PHP项目?

我们即将摘录您的文章《Commit message 和 Change log 编写指南》到苏州前端微信公众号,如有疑问及时联系我(qq:496406128),也希望能莅临指导哈~微信号:suzhou_web

光谷社区观光团组团来学习

在Commitizen部分
在运行
`commitizen init cz-conventional-changelog --save --save-exact`
前,需要输入
`npm init --yes`
生成package.json

引用net1pei的发言:

这些commit changelog内容很好,但怎么样应用于一个PHP项目?

因为都是 npm 模块……想必是要玩一下 node 环境的

这篇文章相当有用!

国外的开源世界真的很标准,希望国内也要跟进啊……

下面这个版本是不包含命令行工具的


npm install -g conventional-changelog

是否是应该安装下面这个,才能够使用conventional-changelog命令?


npm install -g conventional-changelog-cli

写了个 shell 脚本,来做你上面的初始化操作

CZ_INIT_SCRIPT='var p=require("./package.json");p.config=p.config||{};p.config.ghooks={"commit-msg":"./node_modules/validate-commit-msg/index.js"};require("fs").writeFileSync("./package.json",JSON.stringify(p,null,2)+require("os").EOL);'
alias cz_init="npm install ghooks validate-commit-msg --save-dev && commitizen init cz-conventional-changelog --save-dev --save-exact && node -e '$CZ_INIT_SCRIPT'"

应使用npm install -g conventional-changelog-cli这个

文中说的应该是CLI

npm install -g conventional-changelog-cli

再者,根据官方Repo的描述,应该是下面的命令才对:

conventional-changelog -p angular -i CHANGELOG.md -s -r 0

求助:
比如说我增加了一个新功能,可以叫:
feat:新功能(feature)

但如果我是把一个功能的内部逻辑调整了一下,比如聊天软件群发,以前是给所有在群里的人ring一下,现在变成把除自己之外的所有人ring一下。这个既不算代码优化,也不算bug修复,也不是新功能,这种应该叫什么?

引用石樱灯笼的发言:

求助:
比如说我增加了一个新功能,可以叫:
feat:新功能(feature)

但如果我是把一个功能的内部逻辑调整了一下,比如聊天软件群发,以前是给所有在群里的人ring一下,现在变成把除自己之外的所有人ring一下。这个既不算代码优化,也不算bug修复,也不是新功能,这种应该叫什么?

应该叫 refactor

请问阮老师,body如何换行写?回车之后就让写关闭closed了

引用小A的发言:

文中说的应该是CLI

npm install -g conventional-changelog-cli

再者,根据官方Repo的描述,应该是下面的命令才对:

conventional-changelog -p angular -i CHANGELOG.md -s -r 0

太对啦,不用cli conventional-changelog会报错的,无法执行,是不是以前的安装都会默认安装cli,现在好多都要手动去安装cli命令

我要发表看法

«-必填

«-必填,不公开

«-我信任你,不会填写广告链接