讓你的 git commit message 更容易閱讀
讓版控更加容易追蹤 :
習慣上會將每個 commit 的內容盡量限縮在單一單元或一件事上,以讓你的 commit message 和異動處能夠簡潔的對應,對於自己或團隊成員在追蹤進度、回顧異動上都能提高效率。
在這之上能更快表達此次 commit 意義的做法,就是在 commit message 開頭加上前綴字,常見的有 :
- 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)。
加上前綴字之後一看就能先猜到在做什麼,之後再閱讀你改動的訊息就能更快進入狀況。
參考
如果您喜歡我的文章,歡迎幫我在下面按5下讚!感謝您的鼓勵和支持!
All articles in this blog are licensed under CC BY-NC-SA 4.0 unless stating additionally.
Comment