摘要
近期在review團隊的部分代碼,對比個人初期與如今的git提交記錄,發現初期的提交記錄簡直是五花八門,言不由衷,讓人一打眼看去就覺得這寫的什么東西,一個好的git提交記錄既方便個人快速的了解自我的作業進度、快速的回退版本等,又便于團隊之間的協同開發,故分享一下當前最為規范、流行的git commit提交規范,希望這次分享可以幫助到你,
Commit Message格式
每次我們的提交代碼改動,commit message包括三個部分:Header、Body和Footer,(Header是必須的,Body和Footer可以省略,參考阮大神的文,下面只講header的規范寫法,其余部分可以瀏覽阮大神文章進行學習)
Header
Header包含三個欄位:type、scope和subject(type和subject是必須的)
(1)type
feat:新特性、新增feature
fix:修改問題、修復bug
refactor:代碼重構:沒有新增新功能或修復bug
docs:檔案修改:僅僅是修改了檔案,例如README.MD
style:代碼格式修改,注意不是css修改(僅僅是對格式進行修改,例如逗號、縮進、空格等,不改變代碼邏輯)
test:測驗用例修改:包括單元測驗、集成測驗
chore:其他修改,比如改變構建流程、或增加洗掉依賴庫、工具等
pref:優化相關:如提升性能、用戶體驗等
revert:版本回滾
build:構造工具或外部依賴的改動,例如webpack、npm
ci:與CI(持續集成服務)有關的改動
(2)scope
scope用于說明commit影響的范圍,比如component,route等等,根據專案的情況進行不同的情況改動,
(3)subject
subject是commit目的的簡要概述,不超過50字符,
測驗
提交改動記錄
git commit -m "feat(src/pages/case):添加案例輪播圖下一頁導航按鈕"
提交結果

參考文獻
https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html
轉載請註明出處,本文鏈接:https://www.uj5u.com/qiye/53649.html
標籤:JavaScript
