前端代码git提交规范插件Commitizen详解

在一个团队里,如果不制定一个git提交规范,每个人都会按照自己的规范进行提交,这将导致提交的信息比较乱。所以需要制定一个 Commit Message范式,内容应该清晰明了,指明本次提交的目的,便于日后追踪问题。

[Commitizen]是一个撰写符合上面Commit Message标准的一款工具,可以帮助开发者提交符合规范的Commit Message。

1.安装

npm install commitizen cz-conventional-changelog --save-dev

其中,cz-conventional-changelog是本地适配器。

2.配置

安装好Commitizen之后,就需要配置Commitizen,我们需要在package.json中加入以下代码。其中,需

要增加一个script,使得我们可以通过执行npm run cm

来代替git commit,而path为cz-conventional-changelog包相对于项目根目录的路径。

”script": {  "cm: "git-cz"},"config": {
  "commitizen": {
    "path": "./node_modules/cz-conventional-changelog"
  }
}

配置完成之后,我们就可以通过执行npm run cm来代替git commit,接着只需要安装提示,完成

header、body和footer的编写,就能够编写出符合规范的 Commit Message。

前端代码git提交规范插件Commitizen详解_第1张图片

3.可视化提交工具

我们可以在Vscode 中 安装 git-commit-plugin 插件。

前端代码git提交规范插件Commitizen详解_第2张图片
安装完成后,我们可以更改一些文件,使用 git add . 添加

然后在vsCode 左侧菜单 源代码管理器中 使用可视化工具进行提交。
前端代码git提交规范插件Commitizen详解_第3张图片
接下来根据工具指引来做相关的操作即可:

1.提交类型
前端代码git提交规范插件Commitizen详解_第4张图片
前端代码git提交规范插件Commitizen详解_第5张图片
依次点击每一项进行提交信息。

当编写完成之后,可以得到符合规范的Commit Message,这个时候就可以放心将Commit Message及所修改的文件进行提交啦。

你可能感兴趣的:(web前端,Commitizen,提交规范插件)