修正 type、scope 的格式,提供繁體中文提交示例與不相容變更標示。
適用:採 Conventional Commits 1.0 的專案;團隊原有規範優先。
格式
type(scope): 簡短摘要
說明修改原因與使用者可觀察的結果。
BREAKING CHANGE: 描述相容性影響與遷移方式。scope 可省略,不寫成 type: scope : subject。feat 表示新增功能、fix 表示修正錯誤;docs、test、refactor、build、ci、chore 為常見團隊擴充,不由此規格統一定義發布版本。原筆記的 modify/delete 可保留為歷史團隊習慣,但不要混稱標準 type。
依結果命名
fix(search): 修正更新日期的顯示
搜尋結果改用 lastmod,缺值時才回退到發布日期。feat(api)!: 調整任務查詢回應格式
BREAKING CHANGE: items 改為 tasks,客戶端需更新欄位名稱。不相容變更可以用 ! 或 BREAKING CHANGE footer 表示。摘要說明改變,不只寫「修改程式」或羅列檔名。若只是資料層重構且行為不變,使用 refactor 比 feat 清楚。
提交前檢查
閱讀 git diff --cached,確認訊息與 staged 內容相符。一個提交有一個可理解目的;功能和必要測試可同一提交,不相關格式化另外拆。不要為了美觀把本來可獨立回滾的改動混在一起。產生訊息工具只協助草擬,提交者仍需核對實際 diff。
冒險者留言
comments powered by Disqus