
优质文章,实时更新,不容错过!
Git作为当前市场上最流行的版本控制工具,其commit message的质量对于代码维护的效率至关重要。在日常开发中,由于缺乏commit message的规范,导致提交内容随意、质量参差不齐,给代码维护带来困扰。引入commit message规范已经迫在眉睫。
那么,应该采用什么样的规范呢?
目前比较流行的方案是约定式提交规范(Conventional Commits),它受到Angular提交准则的启发,并提供了一组简单的规则,以创建清晰的提交历史。这种规范与SemVer相吻合,可以在提交信息中描述新特性、bug修复和性变更。其message格式如下:
[可选的作用域]:
[可选的正文]
[可选的脚注]
下面快速介绍一下如何实施:
1. 安装commitizen和cz-conventional-changelog:
commitizen是一个用于撰写合格commit message的工具,可以代替git commit指令。而cz-conventional-changelog适配器则提供了conventional-changelog标准(即约定式提交标准)。
全局安装命令如下:
bash
npm install -g commitizen cz-conventional-changelog
echo ‘{ “path”: “cz-conventional-changelog” }’ > ~/.czrc
安装完毕后,直接使用git cz代替git commit。
2. 在项目中安装commitlint和husky:
commitlint用于对commit message进行格式校验,而husky则提供更易用的git hook。
使用npm或yarn进行安装:
bash
npm i -D husky @commitlint/config-conventional @commitlint/cli
或使用yarn进行安装
yarn add husky @commitlint/config-conventional @commitlint/cli -D
请注意,commitlint只能进行格式规范,内容的质量把控还需要我们自己的努力。
3. 配置相关设置:
创建commitlint.config.js文件,并引入husky。具体的配置信息可以在文件中进行设定。
4. 使用方法:
执行git cz进入交互式模式,根据提示依次填写相关信息。包括改动类型、改动范围、描述等。生成的commit message格式如下:
():
