Git Commit 规范

·  阅读 971

AngularJS团队的AngularJS Git Commit Message Conventions是目前使用最广的规范,清晰的提交信息会使我们很容易追踪定位项目历史。

使用最多的格式规范如下:

type(scope?): subject
body?
footer?
复制代码

git commit 引导

Commitizen将提示和引导我们在提交时填写所需的提交字段。

在提交时执行git cz代替git commit

Image


git commit 校验

Commitlint能够帮助团队遵守git commit规范,当提交信息不符合格式规范时,提交钩子运行后拒绝提交。

使用时只需安装依赖:npm install --save-dev commitizen @commitlint/cli @commitlint/config-conventional

.commitlintrc.yml中配置规则Rules。 并在package.json中添加:

"scripts": {
  "commitmsg": "commitlint -E GIT_PARAMS"
}
"husky": {
  "hooks": {
    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
  }
}
复制代码

效果如下:

Image

Enjoy 😉.

分类:
阅读
标签:
分类:
阅读
标签:
收藏成功!
已添加到「」, 点击更改