跳至主要内容

git-cz

git-cz 介紹​

使用 git-cz 可以讓 commit message 更整齊統一，讓 commit message 更好懂。

Commit Type 介紹​

  • feat : 增加新功能
  • fix : bug 的修改
  • docs : 文件上的變更
  • style : 程式碼風格的修改
  • refactor : 重購或優化程式碼
  • perf : 效能優化相關的程式碼
  • test : 增加測試
  • build : build 相關的修改 (像是 gulp, broccoli, npm)
  • ci : CI (持續整合) 相關的變更
  • chore : 其他不修改原始碼或測試檔案的變更
  • revert : 還原之前的 commit 提交

全域安裝​

npm install -g commitizen cz-conventional-changelog
echo { "path": "cz-conventional-changelog" } > C:\Users\<YourUsername>\.czrc

專案安裝​

npm install -D commitizen cz-conventional-changelog

package.json 加上

"script": {
    ...,
    "commit": "git-cz",
},
"config": {
    "commitizen": {
      "path": "cz-conventional-changelog"
    }
}