如何写好 Git Commit

一,写好 Git Commit 信息的 7 个建议

1.用空行分开主题和正文

2.限制主题在50个字母

3.主题行首字母要大写

4.不要用句号结束主题行

5.主题行用祈使语气

6.每行72个字

7.在正文部分解释什么,为什么,以及怎么做的

 

二,Commit message 编写指南

Commit message 的格式

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

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

其中,Header 是必需的,Body 和 Footer 可以省略。

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


1. Header

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

(1)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 用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

(3)subject 是 commit 目的的简短描述,不超过50个字符。以动词开头,使用第一人称现在时,比如change,而不是changed或changes,第一个字母小写结尾不加句号(.)


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


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.

(2)关闭 Issue

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

Closes #234

也可以一次关闭多个 issue 。

Closes #123, #245, #992


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



参考:

https://www.jianshu.com/p/0117334c75fc

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


修改时间 2018-06-06

真诚赞赏,手留余香
赞赏
随机推荐
babel-preset-env 一个就够了
PHP 一次查询生成二维 Json
javascript 为什么判断是否相等用===,而不是==
JavaScript判断变量是否为undefined两种方式差异
macOS卸载Android Studio
20180114梦奇
微信支付的一个问题
CentOS 7 编译安装 Nginx,Naxsi Waf 和 PHP 手记
RESTful API 设计指南
MySQL中UNION和UNION ALL的使用