git commit message規範
<type>(<scope>): <subject>
// 空一行
<body>
- type:必須;
- scope:可選;
- subjecct:必須;
- body:可選;
例子:
feat *: 開發系統用戶管理功能
本次開發的系統用戶管理功能,包括:
- 系統登錄
- 忘記密碼
- ...
- ...
type規範(必選)
type有9種,也可繼續自定義:
- feat:提交新功能(feature);
- fix:提交bug修復補丁;
- docs:編寫文檔(documentation);
- style: 調整代碼格式(不影響代碼運行的變動);
- refactor:對代碼進行重構(即不是新增功能,也不是修改bug的代碼變動);
- test:提交對代碼的測試;
- chore:構建過程或輔助工具的變動;
- revert:撤銷之前的提交;
- pref:對代碼進行性能優化(不影響代碼運行、也不對代碼進行重構);
scope規範(可選)
scope用於說明 commit 影響的範圍,比如數據層、控制層、視圖層等等,視項目分層架構不同而不同。
subject規範(必選)
subject 是 commit 目的的簡短描述,不超過 50 個字符。
注意:subject
結尾不要添加標點符號。
body規範
Body是對這次提交的詳細描述,可分爲多行。