Commitizen 互联网公民的简单提交惯例

510 阅读1分钟

安装命令行工具

安装就像运行以下命令一样简单(如果看到 EACCES 错误,阅读 修复 npm 权限 可能有帮助):

npm install -g commitizen

使用命令行工具

现在,只需使用 git cz 而不是 git commit 提交时。

  • 或者 *,如果您使用的是 NPM 5.2+,则可以 使用 npx 而不是全局安装:
npx git-cz

或者作为 npm 脚本:

  ...
  "scripts": {
    "commit": "npx git-cz"
  }

当您在 Commitizen 友好存储库中工作时,系统将提示您填写任何必填字段,并且您的提交消息将根据项目维护人员定义的标准进行格式化。

add-commit.png

如果您不在 Commitizen 友好存储库中 git cz 工作,那么将使用相同 git commitnpx git-cz 将使用 streamich / git-cz 适配器。

常规提交消息作为全局实用程序

commitizen 如果您还没有全局安装。

npm install -g commitizen

commitizen 例如,全局安装首选适配器 cz-conventional-changelog

npm install -g cz-conventional-changelog

.czrchome 目录中创建一个文件,并 path 引用首选的全局安装的 commitizen 适配器

echo '{"path":"cz-conventional-changelog"}' > ~/.czrc

你们都准备好了!现在 cd 进入任何 git 存储库并使用 git cz 而不是,git commit 你会发现 commitizen 提示。

提示:可以使用所有 git commit optionsgit cz,例如:git cz -a

参考:commitizen.github.io/cz-cli/