git提交规范

介绍

参考angular团队的git提交规范

提交规范

格式: type (scope): subject

- type
- 用于说明 `commit` 的类别，只允许使用下面10个标识。
- feat：新功能（feature）
- fix：修补bug
- docs：文档（documentation）
- style： 格式（不影响代码运行的变动）
- refactor：重构（即不是新增功能，也不是修改bug的代码变动）
- perf：性能优化
- test：增加测试
- chore：构建过程或辅助工具的变动
- revert：回退
- build：打包
- scope(可选)
- 用于说明 `commit` 影响的范围，比如Button组件、store、首页、路由等等，视项目不同而不同。
- subject(可选))
- 是 `commit` 目的的简短描述，不超过50个字符。
- 以动词开头，使用第一人称现在时，比如change，而不是changed或changes
- 第一个字母小写
- 结尾不加句号（.）

校验

提交的代码必须通过 eslint 的校验(可通过 husky 自动完成)

自动化

husky + commitizen + prettier

"lint-staged": {
"*.{js,jsx,less,scss,md,json}": [
"prettier --write",
"git add"
],
"*.ts?(x)": [
"prettier --parser=typescript --write",
"git add"
]
},
"husky": {
"hooks": {
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
}
},
"config": {
"commitizen": {
"path": "./node_modules/cz-customizable"
}
},

执行提交

$ git add . && git cz
Edit this page