Commitizen 互聯網公民的簡單提交慣例

安裝命令行工具

安裝就像運行如下命令同樣簡單（若是看到 EACCES 錯誤，閱讀 修復 npm 權限 可能有幫助）：

npm install -g commitizen
複製代碼

使用命令行工具

如今，只需使用 git cz 而不是 git commit 提交時。

• 或者 *，若是您使用的是 NPM 5.2+，則能夠 使用 npx 而不是全局安裝：

npx git-cz
複製代碼

或者做爲 npm 腳本：

...
  "scripts": {
    "commit": "npx git-cz"
  }
複製代碼

當您在 Commitizen 友好存儲庫中工做時，系統將提示您填寫任何須填字段，而且您的提交消息將根據項目維護人員定義的標準進行格式化。

若是您不在 Commitizen 友好存儲庫中 git cz 工做，那麼將使用相同 git commit 但 npx git-cz 將使用 streamich / git-cz 適配器。

常規提交消息做爲全局實用程序

commitizen 若是您尚未全局安裝。

npm install -g commitizen
複製代碼

commitizen 例如，全局安裝首選適配器 cz-conventional-changelog

npm install -g cz-conventional-changelog
複製代碼

.czrc 在 home 目錄中建立一個文件，並 path 引用首選的全局安裝的 commitizen 適配器

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

大家都準備好了！如今 cd 進入任何 git 存儲庫並使用 git cz 而不是，git commit 你會發現 commitizen 提示。

提示：能夠使用全部 git commit options 帶 git cz，例如：git cz -a。

參考：commitizen.github.io/cz-cli/