閱讀筆記

git 應該是目前開發者的日常使用工具，除了會使用 git 工具，但是開發者往往忙於解決問題而忽略了在 commit 時要記錄哪些內容

這篇文章作者展示了一個真實的 git commit 的範例並說明了這樣的 commit 風格帶來什麼樣的好處，整理一下一個優良的 git commit 要具備那些要素 ( 詳細的 git commit 範例請看原文 )

1. 解釋原始碼變更的原因

不要只說明改變了什麼，還要說明為什麼？

2. 提供可搜尋的關鍵字

文章中的 commit 是記錄了系統丟出來的錯誤訊息 invalid byte sequence in US-ASCII，所以其他開發者下次遇到同樣的錯誤訊息可以使用 git log —grep "invalid byte sequence" 來搜尋

3. 說一個故事

除了說明問題的本身，還敘述了問題調查和修復的過程

4 讓每一個人變個更聰明一點

記錄了解決過程中使用的工具或指令，透過這個機會向團隊傳播知識

5 建立同理心與信任感