git 提交规范

写在前面

关于 git 的常用命令,无须赘述。有兴趣的同学可以自行深入了解。

git 的配置,可参考 《git shell 配置》

重要性

git 之所以成为最流行、使用范围最广的版本管理软件,最大优势就是在 git push 之前,所有操作都是基于本地的。

也即是说,完全可以自己充分开发、测试、修订后,再将最大概率上正确的代码提交至代码库。

**** 而这一点,往往是最容易被忽视的。****

对代码库的每次 commit,都是我们对自己做出的一个承诺,所以要谨慎、细心、并心存敬畏。

而对代码库的每次 push,都将会影响到 线上已存在的功能push 操作也标志本次需求开发完结,所以在发出这个命令前,一定要确保自己十分明确这次提交的 影响范围

提交规范

本规范,参考了 Angular 规范,我们可做相关简化。

下面做具体描述。

标准格式

1
2
3
4
5
<type>(<scope>): <subject> ### -> header
// 空一行
<body>
// 空一行
<footer>
  • 注:Header 是必需的,Body 和 Footer 可以省略。

格式讲解

1、Header

Header部分只有一行,包括三个字段:

  • type(必需)
  • scope(可选)
  • subject(必需)

注意:请在 type 后使用半角冒号(:),且在冒号后留一空格。

1.1 type

用于说明本次commit的类别,只允许使用下面7个标识

  • feat:新功能(feature)
  • fix:修补 bug
  • docs:文档(documentation)
  • text:文案修改,不影响代码逻辑
  • style:格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • test:增加测试 foo
  • chore:构建过程或辅助工具的变动

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

1.2 scope

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

1.3 subject

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

  • 以动词开头,使用第一人称现在时,比如 change,而不是 changed 或 changes。

  • 第一个字母小写。

  • 结尾不加句号(.)

2、Body

用于对本次 commit 的详细描述,可以分成多行。下面是一个范例。

1
2
3
4
5
6
7
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

有两个注意点:

  • 使用第一人称现在时,比如使用 change,而不是 changed 或 changes。

  • 应该说明代码变动的动机,以及与以前行为的对比。

3、Footer

Footer 部分只用于两种情况。

3.1 不兼容变动

如果当前代码与上一个版本不兼容,则 Footer 部分以 BREAKING CHANGE 开头,后面是对变动的描述、以及变动理由和迁移方法。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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.
3.2、关闭 Issue

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

1
Closes #234

也可以一次关闭多个 issue:

1
Closes #123, #245, #992

4、Revert(可忽视)

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

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

提交频率

关于什么时候提交一次:

每次你写完一个功能的时候,就应该做一次提交(这个提交是提交到本地的 git 库中)

当然,这里的写完表示的是你的这个功能是没有问题的。