前言

按照Git工作流的规范,Git中的每次代码提交,都要写 Commit message(提交说明),否则就不允许提交

$ git commit -m "hello world"

上面代码的-m参数,就是用来指定 commit mesage 的

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

$ git commit

基本上,你写什么都行。

但是,一般来说,commit message 应该清晰明了,说明本次提交的目的,如下图
3231510530

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

Commit message 的作用

格式化的Commit message,有几个好处

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

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

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

可以过滤某些commit(比如注释改动),便于快速查找信息

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

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

可以直接从commit生成Change log。

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

Commit message 的格式

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

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
其中,Header 是必需的,Body 和 Footer 可以省略

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

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

type

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

  • feat:新功能(feature)
  • fix:修复bug
  • docs: 仅仅修改了文档,比如README, CHANGELOG, CONTRIBUTE等等(documents)
  • style: 仅仅修改了空格、格式缩进、都好等等,不改变代码逻辑(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • perf: 优化相关&依赖等,比如提升性能、体验的改动
  • test: 测试用例,包括单元测试、集成测试等
  • chore: 改变构建流程、或者增加依赖库、工具等
  • revert: 回滚到前面的版本

如果type为feat和fix,则该 commit 将肯定出现在 Change log 之中。其他情况(docs、chore、style、refactor、test)由你决定,要不要放入 Change log,建议是不要。type代表某次提交的类型,比如是修复一个bug还是增加一个新的feature

scope

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

subject

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

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

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. 应该说明代码变动的动机,以及与以前行为的对比。

Footer 部分只用于两种情况。

不兼容变动

如果当前代码与上一个版本不兼容,则 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.

关闭 Issue

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

Closes #234
也可以一次关闭多个 issue 。

Closes #123, #245, #992

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小标题下面。

参见


ivweb_程柳锋-Git commit message和工作流规范
阮一峰-Commit message 和 Change log 编写指南