Image

大年初一的，大家一定忍不住想趕快 Coding 了吧(?)

這邊轉貼一篇我查閱頻率超高的工具文章，讓大家在龍年 Commit 的時候可以龍謀問題：
Git Commit Message 這樣寫會更好，替專案引入規範與範例

這篇裡最推薦大家看的部份是「好與不好的真實案例」，完全體現出好的 Commit Message 對 抓戰犯 釐清問題是多麼的有幫助

就像文章裡面提到的：

Commit Message 最好兼俱 Why 及 What，讓日後進行維護人員更快進入狀況

不能只把 Git 當作程式碼的 FTP，要把 Git 當作歷史查閱的工具才拿發揮 Git 的功能

並且，這篇文章列出了常見的分類，並且每個分類都有一組明確的範例，很值得參考：

  • feat: 新增/修改功能 (feature)
  • fix: 修補 bug (bug fix)
  • docs: 文件 (documentation)
  • style: 格式 (不影響程式碼運行的變動 white-space, formatting, missing semi colons, etc)
  • refactor: 重構 (既不是新增功能，也不是修補 bug 的程式碼變動)
  • perf: 改善效能 (A code change that improves performance)
  • test: 增加測試 (when adding missing tests)
  • chore: 建構程序或輔助工具的變動 (maintain)
  • revert: 撤銷回覆先前的 commit 例如：revert: type(scope): subject (回覆版本：xxxx)

曾經遇過每個 Commit 只會寫「add」的同事，那時候就深刻體悟到：

不管是個人開發或是團隊合作，有良好的 Commit Message 習慣，在釐清歷史紀錄或是找某一行當初是什麼變動的場合，真的非常方便

那麼，今天的轉貼就先到這邊。明天見 ><