-
Notifications
You must be signed in to change notification settings - Fork 31
Commit Message 规范
Git 每次提交代码，都要写 Commit Message（提交说明），否则就不允许提交。如果一行不够，可以只执行git commit，就会跳出文本编辑器，让你写多行。一般来说，Commit Message 应该清晰明了，说明本次提交的目的。
gio-design 仓库已内置依赖 commitizen, cz-conventional-changelog，不需要再自己执行全局安装。
commit 方式为：
$ git cz然后根据命令行提示填写 commit message。
格式化的 Commit Message，有几个好处：
- 提供更多的历史信息，方便快速浏览。
- 可以过滤某些 commit（比如文档改动），便于快速查找信息。
- 可以直接从 commit 生成 Change log。
每次提交，Commit Message 都包括三个部分：Header、Body 和 Footer。
<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
其中，Header 是必需的，Body 和 Footer 可以省略。
不管是哪一个部分，任何一行都不得超过 72 个字符（或 100 个字符）。这是为了避免自动换行影响美观。
Header 部分只有一行，包括三个字段：type（必需）、scope（可选）和subject（必需）。
type 用于说明 commit 的类别，只允许使用下面 8 个标识：
- feat：新功能（feature）
- fix：修补 bug
- docs：文档（documentation）
- style：格式（不影响代码运行的变动）
- refactor：重构（即不是新增功能，也不是修改bug的代码变动）
- test：增加测试
- chore：构建过程或辅助工具的变动
- perf：提高性能
如果 type 为 feat 和 fix，则该 commit 将肯定出现在 Change log 之中。其他情况（docs、chore、style、refactor、test、perf）不要放入 Change log。
scope 用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。
subject 是 commit 目的的简短描述，不超过 50 个字符。
- 以动词开头，使用第一人称现在时，比如
change，而不是changed或changes。 - 第一个字母小写
- 结尾不加句号（.）
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
有两个注意点：
- 使用第一人称现在时，比如使用 change 而不是 changed 或 changes。
- 应该说明代码变动的动机，以及与以前行为的对比。
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
还有一种特殊情况，如果当前 commit 用于撤销以前的 commit，则必须以revert:开头，后面跟着被撤销 commit 的 Header。
revert: feat(pencil): add 'graphiteWidth' option
This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
Body部分的格式是固定的，必须写成This reverts commit .，其中的hash是被撤销 commit 的 SHA 标识符。
如果当前 commit 与被撤销的 commit，在同一个发布（release）里面，那么它们都不会出现在 Change log 里面。如果两者在不同的发布，那么当前 commit，会出现在 Change log 的 Reverts 小标题下面。
Commitizen 是一个撰写合格 Commit Message 的工具。
安装命令如下：
$ npm install -g commitizen然后，在项目目录里，运行下面的命令，使其支持规范的 Commit Message 格式：
$ commitizen init cz-conventional-changelog --save --save-exact以后，凡是用到 git commit 命令，一律改为使用 git cz。这时，就会出现选项，用来生成符合格式的 Commit Message。
commitlint 帮助您的团队遵守提交约定。
安装：
$ npm install -g @commitlint/cli @commitlint/config-conventional配置：
$ echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js接着，把这个脚本加入 git 的 hooks 里。下面是在 package.json 里面使用 husky，把这个脚本加为 commit-msg 时运行。
{
"husky": {
"hooks": {
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
}
}然后，每次 git commit 的时候，这个脚本就会自动检查 Commit Message 是否合格。如果不合格，就会报错。