Git Commit message(Angular规范)

2020-01-09 本文已影响0人心至靜行至遠

Commit message 的格式

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Header部分只有一行，包括三个字段：type(必需)、scope(可选)和subject(必需)。

type用于说明commit 的类别，只允许使用下面12个标识。

feat：新功能（feature）
fix：修补bug
improvement: An improvement to a current feature
docs：文档（documentation）
style：格式（不影响代码运行的变动）
refactor：重构（即不是新增功能，也不是修改bug的代码变动）
perf: A code change that improves performance
test：增加测试
build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
chore: Other changes that don't modify src or test files
revert: Reverts a previous commit

scope用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。

subject是 commit 目的的简短描述，不超过50个字符。
以动词开头，使用第一人称现在时，比如change，而不是changed或changes
第一个字母小写
结尾不加句号（.）

Body 部分是对本次 commit 的详细描述，可以分成多行。有两个注意点:

Footer 部分只用于两种情况:

如果当前代码与上一个版本不兼容，则 Footer 部分以BREAKING CHANGE开头，后面是对变动的描述、以及变动理由和迁移方法。

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

npm install -g commitizen

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

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

以后，凡是用到git commit命令，一律改为使用git cz。这时，就会出现选项，用来生成符合格式的 Commit message。

npm install -g validate-commit-msg

npm install -g husky

添加配置到package.json, 如果没有此文件，在工程目录执行命令

npm init

{
  "husky": {
    "hooks": {
      "commit-msg": "validate-commit-msg"
    }
  }
}