git commit 規範化信息提交工具

靈感來源於這篇文章java

1. 標準化 commit message

規範且有意義的提交記錄,有助於追蹤代碼修改和查看歷史記錄
如今支持如下九種類型(參考 Angular 規範的 commit message)git

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

2. 使用效果

使用效果

3. 安裝

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

  • 方法一shell

    把 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 提供的命令提示模塊

相關文章
相關標籤/搜索