目的
統(tǒng)一團(tuán)隊(duì)Git commit日志標(biāo)準(zhǔn),便于后續(xù)代碼review,版本發(fā)布以及日志自動(dòng)化生成等等。
統(tǒng)一團(tuán)隊(duì)的Git工作流,包括分支使用、tag規(guī)范、issue等
Git commit日志參考案例
總體方案
Git commit日志基本規(guī)范
<type>(<scope>): <subject><BLANK LINE><body><BLANK LINE><footer>
對(duì)格式的說(shuō)明如下:
type代表某次提交的類型,比如是修復(fù)一個(gè)bug還是增加一個(gè)新的feature。所有的type類型如下:
feat: 新增feature
fix: 修復(fù)bug
docs: 僅僅修改了文檔,比如README, CHANGELOG, CONTRIBUTE等等
style: 僅僅修改了空格、格式縮進(jìn)、都好等等,不改變代碼邏輯
refactor: 代碼重構(gòu),沒(méi)有加新功能或者修復(fù)bug
perf: 優(yōu)化相關(guān),比如提升性能、體驗(yàn)
test: 測(cè)試用例,包括單元測(cè)試、集成測(cè)試等
chore: 改變構(gòu)建流程、或者增加依賴庫(kù)、工具等
revert: 回滾到上一個(gè)版本
格式要求:
# 標(biāo)題行:50個(gè)字符以內(nèi),描述主要變更內(nèi)容## 主體內(nèi)容:更詳細(xì)的說(shuō)明文本,建議72個(gè)字符以內(nèi)。 需要描述的信