GIT提交日誌規範
爲了保證使用git的日誌提交一致,現規定格式規範如下:
<type>[<scope>]: <subject> //本行內容git在push到中央倉庫時會被校驗
//空行
<body>
//空行
<footer>
注意:type後若使用英文冒號,請多加一個空格。
類型解釋
type
用於說明 commit 的類別,只允許使用下面7個標識,必傳。
feat:新功能(feature)
fix:修補bug
docs:文檔(documentation)
style: 格式(不影響代碼運行的變動)
refactor:重構(即不是新增功能,也不是修改bug的代碼變動)
test:增加測試
chore:構建過程或輔助工具的變動
scope
用於說明 commit 影響的範圍,比如數據層、編譯期等等,視項目不同而變化,可選的。
subject
commit 提交目的的簡短描述,不少於10個字符,,必傳。
body
是對本次 commit 的詳細描述,可以分成多行,可選的,一般不傳。
footer
此處一般有兩種情況,可選的,一般不傳:
1:與上一版本不兼容的變動,應說明變動的描述、以及變動理由和遷移方法。
2:如果當前 commit 針對某個issue(gitlab上所提出的,我們一般用不到,因爲我們的bug都提交在了禪道上),那麼可以在 Footer 部分關閉這個 issue。
IDEA插件安裝使用
- 安裝方法一: 在setting-plugins-marketplace中查詢 git commit template 隨後安裝並重啓idea
- 安裝方法二: 安裝文件夾中的git_commit_template.jar 的插件(選擇從硬盤安裝),隨後重啓idea
- 提交代碼在安裝成功後,commit頁面會多出如下紅圈標註的可點擊圖標,請不要再圖標左下側的文本區域進行註釋編寫,務必點擊此按鈕。
- 在點擊按鈕後,會出現如下彈窗:
- 左邊的每個選型分別對應上述規則。在選擇填寫完成後,會自動生成符合格式的提交文本,如下: