安装就像运行如下命令同样简单(若是看到 EACCES
错误,阅读 修复 npm 权限 可能有帮助):git
npm install -g commitizen
复制代码
如今,只需使用 git cz
而不是 git commit
提交时。github
npx
而不是全局安装:npx git-cz
复制代码
或者做为 npm 脚本:npm
...
"scripts": {
"commit": "npx git-cz"
}
复制代码
当您在 Commitizen 友好存储库中工做时,系统将提示您填写任何须填字段,而且您的提交消息将根据项目维护人员定义的标准进行格式化。工具
若是您不在 Commitizen 友好存储库中 git cz
工做,那么将使用相同 git commit
但 npx git-cz
将使用 streamich / git-cz 适配器。ui
commitizen
若是您尚未全局安装。spa
npm install -g commitizen
复制代码
commitizen
例如,全局安装首选适配器 cz-conventional-changelog
命令行
npm install -g cz-conventional-changelog
复制代码
.czrc
在 home
目录中建立一个文件,并 path
引用首选的全局安装的 commitizen
适配器code
echo '{"path":"cz-conventional-changelog"}' > ~/.czrc
复制代码
大家都准备好了!如今 cd
进入任何 git
存储库并使用 git cz
而不是,git commit
你会发现 commitizen
提示。cdn
提示:能够使用全部 git commit
options
带 git cz
,例如:git cz -a
。blog