安裝:
去IDEA插件應用商城下載。
簡介:
Git Commit message規范采用的是Angular 規范
Angular規范中定義的格式有3個內容:
Header |
|- type(必需) : Type of change:commit的類別;
|- scope(可選):Scope of this change:此次commit的影響模塊;
|- subject(必需):Short description:簡短的描述此次代碼變更的主要內容
Body |
| - 對本次 commit 的詳細描述
Footer |
| - 日常項目中開發,Footer不常用,可為空
1、Header
(1)type
type用於說明commit的類別,常用的標識如下:
- feat:新功能
- fix:修補bug
- docs:文檔
- style: 格式(不影響代碼運行的變動,空格,格式化,等等)
- refactor:重構(即不是新增功能,也不是修改bug的代碼變動)
- perf: 性能 (提高代碼性能的改變)
- test:增加測試或者修改測試
- build: 影響構建系統或外部依賴項的更改(maven,gradle,npm 等等)
- ci: 對CI配置文件和腳本的更改
- chore:對非 src 和 test 目錄的修改
- revert: Revert a commit
(2)scope
scope用於說明 commit 影響的范圍,比如數據層、控制層、視圖層等等,視項目不同而不同。
(3)subject
subject是 commit 目的的簡短描述,不超過50個字符,主要介紹此次代碼變更的主要內容。
2、Body
Body 部分是對本次 commit 的詳細描述,可以分成多行。
例如:
-修改菜單查詢接口
-增加菜單刪除接口
日常項目開發中,如果Header中subject已經描述清楚此次代碼變更的內容后,Body部分就可以為空。
3、Footer
(1)不兼容變動
(2)關閉 Issue
日常項目中開發,Footer不常用,可為空。
撤銷:
若需要撤銷上一次的commit,header部分為:revert: 上一次commit的header內容;
body部分為:This reverts commit xxx,xxx是上一次commit對應的SHA 標識符。
使用:
提交的時候點擊下圖按鈕,即可出現模板:
選擇Type,填寫相應內容,最后點擊提交即可:
注:實踐才是應用的最高境界,大家應大膽去試。