Git Commit 訊息最佳實踐

1. 使用簡潔明瞭的主旨行

  • 限制在 50 個字符以內:保持簡短,有助於在各種工具中顯示時不會被截斷。
  • 首字母大寫:例如 “Add new feature” 而不是 “add new feature”。
  • 使用祈使句:例如 “Fix bug” 而不是 “Fixed bug”。
  • 避免句末標點:例如 “Update README” 而不是 “Update README.”

2. 主旨行和正文之間留一行空行

  • 保持訊息的可讀性和結構清晰。

3. 正文詳細描述

  • 每行不超過 72 個字符:這樣可以在各種工具中更好地顯示。
  • 解釋變更的原因:描述為什麼做這些變更,而不僅僅是做了什麼。
  • 描述變更的細節:包括實現細節、影響範圍以及可能的副作用。
  • 提及相關問題單號:例如 “Resolves: #123″。

4. 使用標籤(Tags)

  • 標籤類型
    • feat:新功能。
    • fix:修復 bug。
    • docs:僅文檔變更。
    • style:格式變更(不影響代碼邏輯)。
    • refactor:重構(即不新增功能也不修復 bug 的代碼變更)。
    • test:添加或修改測試。
    • chore:其他雜務變更。

5. 保持一致性

  • 團隊應該制定並遵守統一的 commit 訊息格式規範。

6. 避免提交臨時或不完整的變更

  • 確保每次 commit 都是自包含的,並且處於可運行狀態。

7. 使用多個 commit 訊息分開不同的變更

  • 不要將多個無關的變更合併到一個 commit 中。

範例

`fix: Fix the actor user interface can’t close

  • Changed the event method to panel actor stop event.

發表迴響