Git 提交信息规范
# Git 提交信息规范
Git 提交信息规范
无论是个人项目还是团队协作中，commit message 都应该清晰明了，遵守一定规范。 目前，社区有多种 commit message 的写法规范。本文介绍 Angular 规范，这是目前使用最广的写法，比较合理和系统化，并且有配套的工具。
# 一. 格式化 commit message 的目的
- 提供更多的历史信息，方便快速浏览。
- 可以过滤某些 commit（比如文档改动），便于快速查找信息。
- 可以直接从 commit 生产 Change Log。
# 二. commit message 的格式
每次提交，commit message 都包括三个部分：Header、Body、Footer。
<type>(<scope>): <subject> # header
# 空一行
<body>
# 空一行
<footer>
2
3
4
5
其中，Header 是必须的，Body 和 Footer 省略。
不管是哪一个部分，任何一行都不得超过 72 个字符（或 100 个字符）。这是为了避免自动换行影响美观。
# 1. Header
Header 部分只有一行：包括三个字段：type（必需）、scope（可选）和 subject（必需）。
（1）type
type 用于说明 commit 的类别，只允许使用下面 7 个标识：
feat: 新功能（feature）fix: 修复 bugdocs: 文档（documentation）style: 格式（不影响代码运行的变动）refactor: 重构（即不是新增功能，也不是修复 bug，而是修改代码逻辑本身以达到改善的代码）test: 增加测试chore: 构建过程或辅助工具的变动
如果 type 为 feat 和 fix，则该 commit 将肯定出现在 Change Log 中。其他情况（docs、chore、style、refactor、test）由你决定，要不要放入 Change Log 中，建议是不要。
（2）scope
用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。
（3）subject
subject 是 commit 目的的简短描述，不超过 50 个字符。
- 以动词开头，使用第一人称现在时，比如 change，而不是 changed 或 changes。
- 第一个字母小写。
- 几位不加句号（.）。
# 2. 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
2
3
4
5
6
7
有两个注意点：
- 使用第一人称现在时，比如使用 change 而不是 changed 或 changes。
- 应该说明代码变动的动机，以及与以前行为的对比。
# 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
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
（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.
2
3
Body 部分的格式是固定的，必须写成 This reverts commit <hash>，其中的 hash 是被撤销 commit 的 SHA 标识符。
如果当前 commit 与被撤销的 commit，在同一个发布（release）里面，那么它们都不会出现在 Change Log 里面。如果两者在不同的发布，那么当前 commit，会出现在 Change Log 的 Reverts 小标题下面。
# 三. 提交频率
关于什么时候提交一次：
每次你写完一个功能的时候，就应该做一次提交（这个提交是提交到本地的 git 库中）。
当然，这里的写完表示的是你的这个功能是没有问题的。
# 四. Angular 规范
Angular规范 (opens new window) 见下图：
# 附：团队协作风格指南
在团队协作中，不管有多少人共同参与同一项目，我们期望每一行代码都像是同一个人编写的。因为需要永远遵循同一套编码规范。