Picker Ready Go

# Git 提交规范

# 一、message 的作用

  • 1、提供更多的历史信息，方便快速浏览。

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

git log <last tag> HEAD --pretty=format:%s
1
  • 2、可以过滤某些commit（比如文档改动），便于快速查找信息。

仅仅显示本次发布新增加的功能。

git log <last release> HEAD --grep feature
1
  • 3、可以直接从commit生成Change log。

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

# 二、格式

每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
1
2
3
4
5

Header 是必需的，Body 和 Footer 可以省略。

# 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 之中。其他情况（docs、chore、style、refactor、test）由你决定，要不要放入 Change log，建议是不要。

# （2）、scope

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

# （3）、subject

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

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

# 2、Body

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

Further paragraphs come after blank lines.

- Bullet points are okay, too
- Use a hanging indent
1
2
3
4

# 3、Footer

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 generally useful for directives so there should be no code using it.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
  • 关闭 Issue

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

Closes #234

Closes #123, #245, #992
1
2
3

# 4、Revert

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

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

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
1
2
3

TIP

revert时，一般是自动生成的 message。

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

如果当前 commit 与被撤销的 commit，在同一个发布（release）里面，那么它们都不会出现在 Change log 里面。如果两者在不同的发布，那么当前 commit，会出现在 Change log 的Reverts小标题下面。

TIP

message 的格式可以在云效或者github上配置，将在每次push时候检测message格式。

# 三、validate-commit-msg

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

  "config": {
    "ghooks": {
      "commit-msg": "./validate-commit-msg.js"
    }
  }
1
2
3
4
5

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

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

# 四、生产Change log

如果你的所有 Commit 都符合 Angular 格式，那么发布新版本时， Change log 就可以用脚本自动生成。

← Branch Merge →