如何寫好git commit message
本篇筆記搬運以及修改WadeHuang
大大的部分文章:
Git Commit Message 這樣寫會更好,替專案引入規範與範例
寫好commit
訊息,造福同行,也為自己積陰德
怎麼寫比較好?
- 註解紀錄在
commit
裡面可以保持程式碼的整潔和可讀性 - 獨立
commit
每個不同意義的異動才不會混在一起 Commit
只包含:Why
和What
Commit
加上issue
編號方便追蹤異動原因
規範範例
詳細規範
type 只允許使用以下類別:
- 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)。
如何寫好git commit message
https://f88083.github.io/2024/01/19/如何寫好git-commit-message/