前言 上周项目代码全面迁移用git来管理了，以前没怎么关注团队童鞋在写commit log的情况，有出现过不管提交多少次，log都写得一模一样得，所以很有必要对commit log来一篇分享。很巧合@阮一峰老师刚放出一篇，很适合现阶段得我们。 正文从这开始～ Git 每次提交代码，都要写 Commit message（提交说明），否则就不允许提交。
如果一行不够，可以只执行git commit，就会跳出文本编辑器，让你写多行。 基本上，你写什么都行 但是，一般来说，commit message 应该清晰明了，说明本次提交的目的。 目前，社区有多种 Commit message 的写法规范。本文介绍Angular 规范（见上图），这是目前使用最广的写法，比较合理和系统化，并且有配套的工具。 一、Commit message 的作用 格式化的Commit message，有几个好处。 (1)提供更多的历史信息，方便快速浏览。 比如，下面的命令显示上次发布后的变动，每个commit占据一行。你只看行首，就知道某次 commit 的目的。 (2)可以过滤某些commit（比如文档改动），便于快速查找信息。 比如，下面的命令仅仅显示本次发布新增加的功能。 (3)可以直接从commit生成Change log。 Change Log 是发布新版本时，用来说明与上一个版本差异的文档，详见后文。 二、Commit message 的格式 每次提交，Commit message 都包括三个部分：Header，Body 和 Footer。
不管是哪一个部分，任何一行都不得超过72个字符（或100个字符）。这是为了避免自动换行影响美观。 2.1 Header Header部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）。 (1)type type用于说明 commit 的类别，只允许使用下面7个标识。 如果type为feat和fix，则该 commit 将肯定出现在 Change log 之中。其他情况（docs、chore、style、refactor、test）由你决定，要不要放入 Change log，建议是不要。 (2)scope scope用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。 (3)subject subject是 commit 目的的简短描述，不超过50个字符。 2.2 Body Body 部分是对本次 commit 的详细描述，可以分成多行。下面是一个范例。 有两个注意点。 （1）使用第一人称现在时，比如使用change而不是changed或changes。 （2）应该说明代码变动的动机，以及与以前行为的对比。 2.3 Footer Footer 部分只用于两种情况。 (1)不兼容变动 如果当前代码与上一个版本不兼容，则 Footer 部分以BREAKING CHANGE开头，后面是对变动的描述、以及变动理由和迁移方法。 (2)关闭 Issue 如果当前 commit 针对某个issue，那么可以在 Footer 部分关闭这个 issue 。 也可以一次关闭多个 issue 。 2.4 Revert 还有一种特殊情况，如果当前 commit 用于撤销以前的 commit，则必须以revert:开头，后面跟着被撤销 Commit 的Header。 Body部分的格式是固定的，必须写成This reverts commit |
|
声明：文章版权归原作者所有 部分文章转自互联网 如有侵权请联系
[邮箱地址] 删除
|
注册
登录
