Skip to main content

Git 慣例式提交

學會基本操作後，撰寫能夠簡單讀懂、能夠被快速定位的提交訊息也很重要，所謂的慣例式提交就是把提交分成幾大種類方便查詢，用起來的感覺像是這樣：

nFPM 的提交模版

慣例式提交

分類​

慣例式提交大致有以下幾種分類

  • feat: 功能類型變更 (feature)。
  • fix: 修復臭蟲。
  • perf: 效能優化 (performance)。
  • refactor: 程式碼重構，可能是優化程式架構。
  • test: 單元測試。
  • chore: 雜務。
  • revert: 撤銷提交，如 git revert。
  • style: 格式化變數等等，無生產相關程式碼變更。
  • docs: 修改文檔。

格式​

之後提交就依照這些分類進行提交，提交格式如下：

git commit -m "分類: 標題

（可選）修改範圍

- 修改內容一
- 修改內容二
- 修改內容三"

以下是一個慣例式提交的範例，每個公司、組織、專案都不一樣但是大同小異，跟大家一樣就可以了

fix: 修復頁面滾動卡住問題

drission_bot.py

- 修復自動滾動時偶發卡住的問題
- 修正滾動位置計算錯誤
- 調整等待時間避免DOM更新不完全

工具​

Conventional Commits 列出很多工具可以使用，這裡整理出 stars 最多的幾個：

  1. commitizen
  2. commitlint
  3. cz-cli
  4. standard-version
  5. semantic-release

還有自動化 CHANGELOG 工具 git-cliff。

自動化​

Git 工具除了慣例式的提交訊息，也可以整合自動化工具在每次提交前檢查提交內容，非常好用。完整文章請見 初嘗 Python 工作流自動化。

玩具​

幫無聊的生活增加一點樂趣