1. 程式人生 > >git commit 規範化資訊提交工具

git commit 規範化資訊提交工具

靈感來源於這篇文章

1. 標準化 commit message

規範且有意義的提交記錄,有助於追蹤程式碼修改和檢視歷史記錄
現在支援以下九種類型(參考 Angular 規範的 commit message)

  • feat: 新功能(feature)
  • fix: 修補bug
  • docs: 文件(documentation)
  • style: 格式(不影響程式碼執行的變動)
  • refactor: 重構(即不是新增功能,也不是修改bug的程式碼變動)
  • test: 增加測試
  • chore: 構建過程或輔助工具的變動
  • perf: 效能優化(performance)
  • tmp: 臨時提交(可用於非 master 分支)

2. 使用效果

工具使用示例

3. 安裝

shell 切換成 zsh,使用 oh-my-zsh 更佳

  • 方法一

    把 git_std_commit.sh 檔案內容拷貝到 ~/.zshrc 中

  • 方法二

    下載 git_std_commit.sh 到某個路徑(dir),
    在 ~/.zshrc 末尾新增 source dir/git_std_commit.sh

工具生效都需要執行 source ~/.zshrc

4. 使用方法

在終端輸入 gcmm

 後,使用 Tab 鍵選擇 commit 型別,然後輸入提交資訊

gcmm-xxx msg1 msg2 ...

當 msg 引數多於一個時,資訊會按照列表提交,如 xxx 1.msg1; 2.msg2.
除了 gcmm-tmp,其他命令必須包含提交資訊

5. 其他

使用 shell 函式是最簡單的實現方法
因為 zsh 就可以使用 Tab 進行選擇了
更好的實現應該使用 zsh 提供的命令提示模組