前言
工作以来一直都通过 git 来管理项目,而每次提交代码时,都需要写 提交说明,否则就不允许提交。
但作为一名噗通前端仔很多时候我都要思考许久这次的提交描述写的到不到位。
然 总有那么一两天...
回过头来单看自己或看同事提交的描述信息时 一头雾水 导致有事仅通过查记录描述找原因时根本不记得那天写了啥
总结了一下原因:太懒了,没有规范约束,时间一长就放飞自我了。
所以git提交规范势在必行
我个人属于字数一多就看不下去的渣仔,所以上面废话完了现在直奔主题,目的方便自己下次回忆翻阅的同时也能帮助到你
对于 git 提交规范 来说不同公司都会有不同标准?网上一搜也一大把的内容,今天在此以Angular团队规范 延伸出的 Conventional Commits specification(约定式提交) 为例,来记录自己看一遍就会了的 git 提交规范
约定式提交规范要求如下:
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
-------- 翻译 -------------
<类型>[可选 范围]: <描述>
[可选 正文]
[可选 脚注]
如果按照 约定式提交规范 来去做的话,那么每一次提交想想都十分繁琐,写了那么久bug 提交代码不应该是很快乐吗!!!那么一定有办法解决这个问题吧?答案是肯定的。
开始愉快的使用
信我的,你甚至不需要了解前置知识
git 提交规范化工具:commitizen
commitizen 仓库名为 cz-cli ,它提供了一个 git cz 的指令用于代替 git commit,简单一句话介绍它:
当你使用
commitizen进行代码提交(git commit)时,commitizen会提示你在提交时填写所有必需的提交字段!
- 全局安装
Commitizen
npm i cz-customizable --save-dev
- 以vue项目为例 添加以下配置到
package.json中
"config": {
"commitizen": {
"path": "node_modules/cz-customizable"
}
}
- 在项目根目录下创建
.cz-config.js自定义提示文件 文件内容如下
module.exports = {
// 可选类型
types: [
{ value: 'feat', name: 'feat: 新功能' },
{ value: 'fix', name: 'fix: 修复' },
{ value: 'docs', name: 'docs: 文档变更' },
{ value: 'style', name: 'style: 代码格式(不影响代码运行的变动)' },
{
value: 'refactor',
name: 'refactor: 重构(既不是增加feature,也不是修复bug)'
},
{ value: 'perf', name: 'perf: 性能优化' },
{ value: 'test', name: 'test: 增加测试' },
{ value: 'chore', name: 'chore: 构建过程或辅助工具的变动' },
{ value: 'revert', name: 'revert: 回退' },
{ value: 'build', name: 'build: 打包' }
],
// 消息步骤
messages: {
type: '请选择提交类型:',
customScope: '请输入修改范围(可选):',
subject: '请简要描述提交(必填):',
body: '请输入详细描述(可选):',
footer: '请输入要关闭的issue(可选):',
confirmCommit: '确认使用以上信息提交?(y/n/e/h)'
},
// 跳过问题 如果你觉得不需要 详细描述或关闭issue描述的话可以 按如下格式配置跳过
//skipQuestions: ['body', 'footer'], 如果不明白 你可以试过一遍后把这行注释打开 看看有何不同
// subject文字长度默认是72
subjectLimit: 72
}
- 使用
git cz代替git commit然后你就可以尝试使用git cz代替git commit,即可看到提示内容,然后根据提示写内容回车下一步下一步就好啦。
上面我说过信我的你甚至不需要了解以上知识到底是什么意思,只需要跟着步骤走完123步,然后亲自体验一下第四步,就完成了以前在我心中高大上的git提交规范了。