好的提交訊息

對於遍歷 git log 的人來說,輕鬆理解每個提交的內容非常重要。良好的提交訊息通常包括跟蹤器中的許多工或問題,以及已完成的內容和原因的簡明描述,有時還包括如何完成。

更好的訊息可能如下所示:

TASK-123: Implement login through OAuth
TASK-124: Add auto minification of JS/CSS files
TASK-125: Fix minifier error when name > 200 chars

以下訊息不太有用:

fix                         // What has been fixed?
just a bit of a change      // What has changed?
TASK-371                    // No description at all, reader will need to look at the tracker themselves for an explanation
Implemented IFoo in IBar    // Why it was needed?

測試提交訊息是否以正確的心情編寫的方法是用訊息替換空白並檢視是否有意義:

如果我新增此提交,我將___到我的儲存庫

一個偉大的 git 提交訊息的七個規則

  1. 用空行將主題線與主體分開
  2. 將主題行限制為 50 個字元
  3. 資本化主題
  4. 不要以句點結束主題行
  5. 使用主題行中的命令式情緒
  6. 手動將身體的每一行包裹在 72 個字元處
  7. 用身體來解釋什麼為什麼而不是如何

Chris Beam 的部落格中有 7 條規則