目的

  • 統(tǒng)一團隊Git commit日志標準,便于后續(xù)代碼review,版本發(fā)布以及日志自動化生成等等。

  • 統(tǒng)一團隊的Git工作流,包括分支使用、tag規(guī)范、issue等

Git commit日志參考案例

總體方案

萬碼學堂,電腦培訓,計算機培訓,Java培訓,JavaEE開發(fā)培訓,青島軟件培訓,軟件工程師培訓

Git commit日志基本規(guī)范

<type>(<scope>): <subject><BLANK LINE><body><BLANK LINE><footer>

對格式的說明如下:

  • type代表某次提交的類型,比如是修復一個bug還是增加一個新的feature。所有的type類型如下:

  • feat: 新增feature

  • fix: 修復bug

  • docs: 僅僅修改了文檔,比如README, CHANGELOG, CONTRIBUTE等等

  • style: 僅僅修改了空格、格式縮進、都好等等,不改變代碼邏輯

  • refactor: 代碼重構,沒有加新功能或者修復bug

  • perf: 優(yōu)化相關,比如提升性能、體驗

  • test: 測試用例,包括單元測試、集成測試等

  • chore: 改變構建流程、或者增加依賴庫、工具等

  • revert: 回滾到上一個版本

格式要求:

# 標題行:50個字符以內,描述主要變更內容## 主體內容:更詳細的說明文本,建議72個字符以內。 需要描述的信息包括:## * 為什么這個變更是必須的? 它可能是用來修復一個bu
        
		

網友評論