引文

每一次用git commit 都要填写 message，自己之前的提交都比较随意，每次提交的格式也都不仅一样，寻找起来也比较困难。

Commit message 的作用

  1. 提供直观明了的历史信息，方便浏览，利用--pretty=oneline可以再一行内确定提交的信息

  2. 可以过滤某些 commit，便于查找

    利用git log HEAD --grep feature可以仅查看发布的新功能

  3. 由 commit 直接生成 Change log

规范

目前使用比较广泛的为 Angular，每次提交都包括三部分：Header，Body 和 Footer。

1
2
3
4
5
<type>(<scope>):<subject>

<body>

<footre>

Header(可选)

Header 部分只有一行，包括三个字段：type（必需）、scope（可选）和 subject（必需）

  1. type
    type用于说明 commit 的类别，只允许使用下面 7 个标识。

    1
    2
    3
    4
    5
    6
    7
    1. feat：新功能（feature）
    1. fix：修补 bug
    1. docs：文档（documentation）
    1. style： 格式（不影响代码运行的变动）
    1. refactor：重构（即不是新增功能，也不是修改 bug 的代码变动）
    1. test：增加测试
    1. chore：构建过程或辅助工具的变动

    如果 type 为 feat 和 fix，则该 commit 将肯定出现在 Change log 之中。其他情况（docs、chore、style、refactor、test）由你决定，要不要放入 Change log，建议是不要。

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

  3. subject
    subject是对 commit 的简短的描述，不超过 50 个字符。

    1
    2
    3
    1. 以动词开头，使用第一人称现在时，比如 change，而不是 changed 或 changes
    1. 第一个字母小写
    1. 结尾不加句号（.）

Body

Body 部分是对本次 commit 的详细描述，可以分成多行。

  1. 使用第一人称现在时，比如使用 change 而不是 changed 或 changes。

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

Footer 部分只用于两种情况。

  1. 不兼容变动
    如果当前代码与上一个版本不兼容，则 Footer 部分以 BREAKING CHANGE 开头，后面是对变动的描述、以及变动理由和迁移方法。
  2. 关闭 Issue
    如果当前 commit 针对某个 issue，那么可以在 Footer 部分关闭这个 issue 。

Revert

如果当前 commit 用于撤销以前的 commit，则必须以 revert:开头，后面跟着被撤销 Commit 的 Header。

引用

本文部分引用于阮一峰的博客