Skip to content

kwangsing3/cz-translated-zhtw

Repository files navigation

cz-translated-zhtw

不知道在 commit 的時候寫什麼? 寫太簡潔怕久了之後自己也看不懂?

此庫是一個依循 Conventional Commit 原則進行提交的 git commit message 開發工具,

基於 Commitizen 運作並製作成繁體中文的擴展元件,可在項目需要時自行添加選項。

Install Package

Install globally

$ npm install -g commitizen cz-translated-zhtw
// touch ~/.czrc (在當前使用者資料夾新增.czrc檔  例如: ~/.czrc)
{
  "path": "cz-translated-zhtw"
}

or locally

$ npm install --save-dev commitizen cz-translated-zhtw
//package.json
"script": {
    "commit": "git-cz",
}
...
...
  "config": {
    "commitizen": {
      "path": "cz-translated-zhtw"
    }
  },
...

Usage

#commit

$ git-cz
# or
$ cz

$ npm run commit #locally
  1. 選取提交項目的種類

    alt text

  2. 依照提示輸入描述

    alt text

  3. 預覽

    alt text

  4. 結果

    alt text

TODO and Others

  • 技術上而言專案的使用及安裝不局限於 NPM 或 Nodejs 項目(可另外 pkg 執行檔)
  • ...
  • ...