# Commit Message convention ## Type of Commit - 提交類型 - feat: 新的功能被添加到應用程式 - 語意版本(semantic versioning) Minor - wip: work in progress - fix: 錯誤修復 - 語意版本(semantic versioning) Patch - style: 與 CSS 相關(功能 && 樣式) - refactor: 重構原始碼 - test: 一切關於測試 - docs: 一切關於文件 - chore: 規律代碼維護 - build: 外部套件更新 ## Scope of commit (Optional) - 提交範圍 - 通常會是一個範圍,白話就是組件 1. feat(claims) 2. fix(orders) ## Subject - 主題 - 對於更動簡短描述(少於50個字,類似文章的標題) - 不應該包含任何標點符號與空格(包含結束句點) - 應該使用現在式或祈使語氣 1. feat(claims): add claims detail page 2. fix(orders): validation of custom specification ## Body (Optional) - 本文 - 寫為什麼要做而不是寫如何做(如何做已經在代碼中了) - 與本文分開使用空格 - 將每行限制為 72 個字元 ## Footer (Optional) - 代碼更改後的影響 - BREAKING CHANGE - 語意版本(semantic versioning) Major ### Git Commit Best Practices - 進行小型、單一用途的提交 - 為了正確管理原始程式碼和更好的內務管理,提交應該是相關更改的包裝器。例如,修復兩個不同的bug應該會產生兩個單獨的提交。 - 小提交使其他開發人員更容易 a)理解更改 b)如果出現問題,請回滾它們。 - 儘早並經常提交 - 儘早提交並經常保持較小的提交,並説明您僅提交相關的更改。此外,它還允許您更頻繁地與他人共用您的代碼並避免合併衝突。 - 徹底測試它以確保它真的完成了並且沒有副作用