摘要css
近期在review團隊的部分代碼,對比我的初期與現在的git提交記錄,發現初期的提交記錄簡直是五花八門,言不禁衷,讓人一打眼看去就以爲這寫的什麼東西。一個好的git提交記錄既方便我的快速的瞭解自個人工做進度、快速的回退版本等,又便於團隊之間的協同開發。故分享一下當前最爲規範、流行的git commit提交規範,但願此次分享能夠幫助到你。html
Commit Message格式webpack
每次咱們的提交代碼改動,commit message包括三個部分:Header、Body和Footer。(Header是必須的,Body和Footer能夠省略,引用阮大神的文,下面只講header的規範寫法,其他部分能夠瀏覽阮大神文章進行學習)git
Headerweb
Header包含三個字段:type、scope和subject(type和subject是必須的)npm
(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