git commit提交規範
阿新 • • 發佈:2021-12-15
規範
大致分為以下3個部分(使用空格或空行分隔)
- 標題行:必填,描述主要修改型別和內容或模組
- 主體內容:描述為什麼修改,做了什麼修改變動,以及開發思路等
- 頁腳註釋:放Breaking Changes 或 Closed Issues
type:commit得型別
- init:初始化
- feat:新特性/新功能
- fix:修改問題/解決bug
- refactor:程式碼重構
- docs:文件修改
- style:程式碼格式修改
- build:構建專案
- chore:其他修改,比如依賴管理
- scope:commit影響得範圍
- subject:commit的描述
body:commit具體修改內容·,可以分多行
footor:一些備註,通常是BREAKING CHANGE 或修復的 bug 的連結
示例
fix(修復BUG)
如果修復的這個BUG隻影響當前修改的檔案,可不加範圍。如果影響的範圍比較大,要加上範圍描述。
例如這次 BUG 修復影響到全域性,可以加個 global。如果影響的是某個目錄或某個功能,可以加上該目錄的路徑,或者對應的功能名稱。
// 示例1
fix(global):修復checkbox不能複選的問題
// 示例2 下面圓括號裡的 common 為通用管理的名稱
fix(common): 修復字型過小的BUG,將通用管理下所有頁面的預設字型大小修改為 14px
// 示例3
fix: value.length -> values.length
feat(新增一個功能)
feat: 實現與中國海關的鏈路通訊
style(如WPF介面調整樣式等)
style:修改登入窗體大小
chore(其他修改)
chore 的中文翻譯為日常事務、例行工作,顧名思義,即不在其他 commit 型別中的修改,都可以用 chore 表示。
chore:去除不必要的依賴
規範在方便他人的同時,也是方便自己。