# git 提交规范 {#git-提交规范}

本文讲述 git 版本控制系统的 git 提交规范。大多数开发团队并没有统一的代码提交规范。若遵守统一的提交规范，方便日后 review 代码，以及了解历史功能的修改方法，甚至可以自动化生成工程的 changelog 文件。

# 1. Commit message 的格式 {#_1-commit-message-的格式}

Commit message 包含 3 部分：Header、Body、Footer。
Header 必填，Body 和 Footer 选填。

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

# 1.1 Header {#_1-1-header}

Header 部分包括 3 个字段：type（必需）、scope（可选）和 subject（必需）。

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，建议是不要。
scope
scope 用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。
subject
subject 是 commit 目的的简短描述，不超过 50 个字符。

# 1.2 Body {#_1-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.3 Footer {#_1-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 generaly useful for directives so there should be no code using it.

关闭 Issue
如果当前 commit 针对某个 issue，那么可以在 Footer 部分关闭这个 issue 。
```
Closes #234
```
也可以一次关闭多个 issue 。
```
Closes #123, #245, #992
```

# 1.4 Revert {#_1-4-revert}

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

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

# 2. 辅助工具 {#_2-辅助工具}

手工编写符合规范的 Commit message，可能容易出错，那么我们可以借助工具 commitizen 来约束。

# 2.1 安装 commitizen {#_2-1-安装-commitizen}

执行如下命令即可完成 commitizen 的安装。

npm install -g commitizen cz-conventional-changelog

# 2.2 配置 commitizen {#_2-2-配置-commitizen}

执行如下命令为 commitizen 配置提交规范

echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc

若您的操作系统是 windows，需要将如上的第 2 个命令转换为 windows 上的写法。
cz-conventional-changelog 代表的是Angular 团队规范 ，这样 commitizen 就会按照Angular 团队规范生成 commit message。

# 2.3 commitizen 工具的使用 {#_2-3-commitizen-工具的使用}

安装完 commitizen 后，在 git 工程目录下执行 git-cz 或 git cz 即可。

> git cz
cz-cli@4.0.3, cz-conventional-changelog@3.0.2
? Select the type of change that you're committing: (Use arrow keys)
> feat:        A new feature
  fix:         A bug fix
  improvement: An improvement to a current feature
  docs:        Documentation only changes
  style:       Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  refactor:    A code change that neither fixes a bug nor adds a feature
  perf:        A code change that improves performance
(Move up and down to reveal more choices)

# 3. 为项目生成 Change log 文件 {#_3-为项目生成-change-log-文件}

想生成 Change log 文件的前提是 commit message 需要符合 Angular 规范。
生成的 Change log 文件为 markdown 格式。

# 3.1 安装工具 {#_3-1-安装工具}

yarn global add conventional-changelog-cli

# 3.2 生成 Change log 文件 {#_3-2-生成-change-log-文件}

在工程目录下执行如下命令即可:
conventional-changelog -p angular -i ./CHANGELOG.md -s

该命令不会覆盖以前的 Change log，只会在 CHANGELOG.md 的头部补充自从上次发布以来的变动。
若想生成所有发布的 Change log, 则执行如下命令
conventional-changelog -p angular -i CHANGELOG.md -s -r 0

生成的 CHANGELOG.md 文件的格式如下:

# 1.0.0 (2019-11-06)
### Features
- **自动化:** 新增自动生成 CHANGELOG 相关功能 ([a9ebf7e](https://github.com/godbasin/wxapp-typescript-demo/commit/a9ebf7ee0ca53a4906ed77106b65f6d6bef92f9b))