mac git stash changes_Git进阶：如何提交标准化的Git Commit Message

如果你对git还不熟或者不了解，请移步Git命令简化笔记--再也不担心找不到通用教程了，我等你回来，这里是进阶篇

Git 每次提交代码，都要写 Commit message(提交说明)，否则就不允许提交。

git commit -m "hello world"

上面代码的-m参数，就是用来指定 commit mesage 的。

如果一行不够，可以只执行git commit，就会跳出文本编辑器，让你写多行。

git commit

基本上，你写什么都行，就像下面这样

但是，一般来说，commit message 应该清晰明了，说明本次提交的目的。

从上面两张图中，我想你已经能看出一些端倪来了吧，相较而言哪种更加能促进开发不言自明。目前，社区有多种 Commit message 的写法规范。本文介绍Angular 规范(见上图)，这是目前使用最广的写法，比较合理和系统化，并且有配套的工具。

一、Commit message 的作用

格式化的Commit message，有几个好处。

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

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

git log  HEAD --pretty=format:%s

(2)可以过滤某些commit(比如文档改动)，便于快速查找信息。

比如，下面的命令仅仅显示本次发布新增加的功能。

git log  HEAD --grep feature

(3)可以直接从commit生成Change log。

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

二、Commit message 的格式

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

(): // 空一行// 空一行

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

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

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

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 so there should be no code using it.

(2)关闭 Issue

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

Closes #234

也可以一次关闭多个 issue 。

Closes #123, #245, #992

2.4 Revert(可省略)

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

revert: feat(pencil): add 'graphiteWidth' optionThis reverts commit 667ecc1654a317a13331b17617d973392f415f02.

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

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

三、Commitizen

Commitizen是一个撰写合格 Commit message 的工具。

安装命令如下(mac下面需要管理员权限，sudo ...)。

 npm install -g commitizen

安装changelog，是生成changelog的工具

npm install -g conventional-changelognpm install -g conventional-changelog-cli

执行

npm ls -g -depth=0

检验上面两个工具是否安装成功，得到结果如下，表示成功：然后，在项目目录里，运行下面的命令，使其支持 Angular 的 Commit message 格式。

/usr/local/lib├── commitizen@2.9.6├── conventional-changelog@1.1.7├── conventional-changelog-cli@1.3.5└── npm@5.5.1

然后，运行下面命令，使其支持Angular的Commit message格式。

commitizen init cz-conventional-changelog --save --save-exact

但是注意，因为commitizen工具是基于Node.js的，而我们iOS项目工程目录下是没有package.json文件，所以会报错：(以下部分作为非node环境下的配置，不关心者可以跳过，直接进入下一部分“使用”教程)

npm WARN saveError ENOENT: no such file or directory, open '/Users/Elite/package.json'npm WARN enoent ENOENT: no such file or directory, open '/Users/Elite/package.json'

对于此种错误，创建一个空的package.json文件，然后进入到项目目录，执行

npm init --yes

会生成项目对应项目的package.json，将项目目录下产生的package.json的内容写入到自己建的package.json(/User/Elite/package.json)中，如果有多个项目，将各项目生成的package.json内容写入到package.json中，下面是我的配置(/User/Elite/package.json)

[{ "name": "salary