git commit规范
git-commit规范
在多人协作项目中，如果代码风格统一、代码提交信息的说明准确，那么在后期协作以及Bug处理时会更加方便
目的
- 统一团队Git commit日志标准，便于后续代码review，版本发布以及日志自动化生成等等。
- 统一团队的Git工作流，包括分支使用、tag规范、issue等
提交规范
提交格式：<type>(<scope>): <describe> // 注意：冒号后面有空格
-
type: 提交类型，其中type的值可以有很多，下面有几个我们常用到的：
- feat：新功能（feature）
- fix：修补bug
- docs：文档（documentation）
- style： 格式（不影响代码运行的变动）
- refactor：重构（即不是新增功能，也不是修改bug的代码变动）
- test：增加测试
- chore：构建过程或辅助工具的变动
-
scope: 用来说明此次修改的影响范围，可以根据自己的习惯写，比如习惯按照功能模块划分，则可以写login，regist等改动的模块，如果习惯按照改动的目录来划分，也可以写store，service，page等等，也可以忽略不写，不能使用驼峰格式。
-
describe: 提交描述
示例
git commit -am 'fix(location): 登录接口地址修改'
commit hook插件接入
- package.json中添加以下代码，并执行npm install
"scripts": {
"log": "conventional-changelog -p angular -i CHANGELOG.md -s -w -r 0"
},
"devDependencies": {
"@commitlint/cli": "7.0.0",
"@commitlint/config-conventional": "7.0.1",
"conventional-changelog-cli": "2.0.1",
"husky": "1.0.0-rc.13",
}
"config": {
"commitizen": {
"path": "cz-customizable"
}
},
"husky": {
"hooks": {
"commit-msg": "commitlint --env HUSKY_GIT_PARAMS",
"post-commit": "npm run log"
}
}
- 项目根目录新建文件：commitlint.config.js, 添加以下内容：
/**
* feat：新功能（feature）
* fix：修补bug
* docs：文档（documentation）
* style： 代码格式（不影响代码运行的变动）
* refactor：重构（即不是新增功能，也不是修改bug的代码变动）
* test：增加测试
* chore：构建过程或辅助工具的变动
*
* 提交格式：<type>(<scope>): <describe> 其中scope可忽略
*
* 提交实例： git commit -am 'fix(location): 登录接口地址修改'
*
*/
module.exports = {
extends: ['@commitlint/config-conventional'],
rules: {
'type-enum': [2, 'always', [
'feat', 'fix', 'docs', 'style', 'refactor', 'test', 'chore', 'revert'
]],
'subject-full-stop': [0, 'never'],
'subject-case': [0, 'never']
}
};
- 将CHANGELOG.md文件添加进.gitignore中，防止每次提交完成之后再生成需要提交的CHANGELOG
查看日志
- 通过git log命令查看提交日志，可以选择类型查看，使用命令：git log --grep xxx(搜索内容)，比如执行：git log --grep feat，将展示所有feat类型的提交
- 执行 npm run log，生成本地CHANGELOG.md文件。其中，CHANGELOG中将只列出fix和feat类型的提交记录
网友评论