用工具思路来规范化 git commit message
作者：互联网
为什么要规范 Git Commit Message
- 发生问题快速识别问题代码
- commit和代码建立联系，和相关prd、bug予以关联。
如何写出规范化的 Git Commit Message
选用当前业界内应用比较广泛的 Angular Git Commit Guidelines
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
-
type：commit的类型：featfixrefactordocsstyletestchore -
scope：commit 影响的范围, 比如: route, component, utils, build… -
subject：commit 的概述- 以动词开头，使用第一人称现在时，比如change，而不是changed或changes
- 第一个字母小写(可以使用中文)
- 结尾没有符号
-
body：commit 具体修改内容, 可以分为多行 -
footer：一些备注, 通常是 BREAKING CHANGE 或修复的 bug 的链接
项目使用参考步骤
1.Commitizen: 替代你的 git commit
commitizen/cz-cli, 我们需要借助它提供的 git cz 命令替代我们的 git commit 命令, 帮助我们生成符合规范的 commit message.
除此之外, 我们还需要为 commitizen 指定一个 Adapter 比如: cz-conventional-changelog (一个符合 Angular团队规范的 preset). 使得 commitizen 按照我们指定的规范帮助我们生成 commit message.
yarn add --dev commitizen cz-conventional-changelog
package.json中配置:
"script": {
...,
"commit": "git-cz",
},
"config": {
"commitizen": {
"path": "node_modules/cz-conventional-changelog"
}
}
如果全局安装过 commitizen, 那么在对应的项目中执行 git cz or npm run commit 都可以
2.Commitlint: 校验你的 message
commitlint: 可以帮助我们 lint commit messages,校验的配置推荐 @commitlint/config-conventional (符合 Angular团队规范).
话不多说直接按照：
yarn add --dev @commitlint/config-conventional @commitlint/cli
同时需要在项目目录下创建配置文件 .commitlintrc.js, 写入:
module.exports = {
extends: [
'@commitlint/config-conventional'
],
rules: {
}
};
3.结合 Husky
yarn add --dev husky
package.json 中添加:
"husky": {
"hooks": {
...,
"commit-msg": "commitlint -e $GIT_PARAMS"
}
},
参考资料
Commit message 和 Change log 编写指南
标签：commitizen,conventional,git,cz,commit,message,commitlint 来源： https://blog.csdn.net/whh181/article/details/91490098