洧杰 已發佈 2019-10-31

如何優雅撰寫 Git Commit 訊息

撰寫好的 commit 訊息,可以幫助你日後回顧時,可以更精準方便回顧,更重要的是讓你的夥伴方便閱讀。

早在 2014 年 Chris Beams 就寫過一篇 How to Write a Git Commit Message,如果裡面有提及重要的七大點。

  1. 將訊息用空白斷航區分標題與內容
  2. 標題限制在 50 字元以內
  3. 標題開頭使用大寫
  4. 標題不以句點結尾
  5. 使用祈使句設計標題
  6. 內容每行最多 72 字,過多文字則需要斷行
  7. 內容需解釋 what 以及 why vs. how

我覺得要了解如何寫出好 commit 訊息,去看看大家怎麼寫得最快,所以這裡我也條列一些開發者與研討會組織給各位參考。

JSDC

第一個搜尋到 JSDC,這其實和我自己的習慣很相像,就是在撰寫時,第一個一定要是「動詞」,如果是中文 commit 訊息,就會寫像是「新增 slider 功能」、「修復 modal BUG」、「刪除贊助訊息」。

images

COSCUP

COSCUP 在撰寫 commit 訊息時,絕大多數開發者都會遵守第一個英文字需要大寫。
images

MOPCON

身為 MOPCON 的腦粉,當然要記錄一下。不論是中英文,也有符合第一個單字是動詞的部分。
images

Bootstrap

在標題開頭大寫上,BS 開發者們也並非都有遵守,不過已經可以看出,大部分開頭都需動詞已經是必要的鐵則。
images

Vue

在 Vue 的規範上,他們是採用第一個單字先描述是什麼任務,例如 chore(瑣事)、fix(修復)、refactor(重構)。接了個冒號再撰寫主要內容。除此之外,我發現 Angular 也是如此。比較起來 React 倒是比較隨性。

images

總結

老話一句,規範是死的,人是活的,通常都還是會依照團隊習慣來訂定規範。看了以上 commit,至少開頭第一個單字要大寫,並且需要是動詞,至少你就不會是團隊中的討厭鬼了 :D

參考文獻

關於筆者

暱稱:洧杰

介紹:六角學院校長,熱愛分享與交流的前端工程師,目前專注於兼容桌面/移動網頁前端開發,期間已協助數百位平面設計師,網頁設計師導入標準網頁設計。

文章列表 文章列表