Commit message 和 Change log 编写指南

转载 2016年01月08日 12:13:12

转自:   http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html


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:构建过程或辅助工具的变动

如果 type 为 feat 和 fix,则该 commit 将肯定出现在 Change log 之中。其他情况(docschorestylerefactortest)由你决定,要不要放入 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 而不是 changed 或 changes

(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.json 的 scripts 字段。


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

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


$ npm run changelog

(完)

Commit message 和 Change log 编写指南

转载http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html Git 每次提交代码,都要写 Commit mes...

Git 提交的正确姿势:Commit message 编写指南

Git 提交的正确姿势:Commit message 编写指南 Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交。 $ git commit -m ...

How to Write a Git Commit Message

  • 2016年04月25日 16:33
  • 1.21MB
  • 下载

git学习--commit-msg缺失导致的missing Change-Id问题分析

转自:http://blog.csdn.net/yanxiangyfg/article/details/50962593 一.简介  commit-msg hook  这个hook由...

git commit 中的change-id

git commit 中的change-id为什么要使用change-id保证已经提交审核的修订通过审核入库后,被别的分支 cherry-pick 后再推送至服务器时不会产生新的重复的评审任务。Ger...

gerrit 删除废弃的提交(Abandoned commit change)

步骤1 gerrit数据库访问授权 首先在gerrit站点确认project config里是否对Administrator组有访问gerrit数据库的权限 使用Administrator组的账户登陆...

git学习--commit-msg缺失导致的missing Change-Id问题分析

一.简介 commit-msg hook 这个hook由’git commit’触发, 且可以通过--no-verify 来略过.它接受一个参数, 包含commit...

修正 Vim(Mac) 有时无法正确提交 Git Commit Message 的问题

因为,有一天突然发现git提交的时候不能写log了,于是就发现了这个诡异的问题。还好万能的网友已经给出了解决办法。 git + vim + mac, 下才会出现这样的情况。 原...
  • veizz
  • veizz
  • 2012年12月03日 15:42
  • 2259

Git commit message和工作流规范

目的 统一团队Git commit日志标准,便于后续代码review,版本发布以及日志自动化生成等等。统一团队的Git工作流,包括分支使用、tag规范、issue等 Git commit日...

写出好的 commit message

为什幺要关注提交信息 加快 Reviewing Code 的过程 帮助我们写好 release note 5年后帮你快速想起来某个分支,tag 或者 commit 增加了什么功能,改变了哪些代码 ...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Commit message 和 Change log 编写指南
举报原因:
原因补充:

(最多只允许输入30个字)