commitizen/cz-cli是一个规范git commit的工具,使用它代替git commit能够方便有效地写好提交的log,使得团队项目的版本信息更清晰。
(全局安装)
npm install -g commitizen cz-conventional-changelog
linux/wsl需要添加一句:
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc
在本地git仓库中,使用git cz
代替git commit
使用。
如果没有像下方的示例一样显示,而是和正常的git commit完全一样,需要自己手写文档的情况时,说明在项目内文件夹 git cz
的安装未生效,使得项目生效需要在项目下操作:
npm init --yes
commitizen init cz-conventional-changelog --save --save-exact
成功初始化即可使用。
示例如下(win10 cmd中):
(Mac shell中):
通过方向键选择我们在此次提交中修改的内容,比如选择feat,回车
commitizen会询问一些小问题,只要回答问题就好了。
比如本次修改的范围是什么?某个文件还是组件?(可以跳过)
对此次修改的简要概括(重要)
进行更长的描述(概括写不下的在这里写)
以及会询问是否为重大修改之类的问题,如实填写即可
最后可以看到,commitizen会为我们创建一个风格规范的优雅的commit log
commit修改类型汇总:
感谢@btapple。
撰稿:冯mh
补充:CookieLau
手机扫一扫
移动阅读更方便
你可能感兴趣的文章