一、為什么需要制定提交規范?
在團隊協作開發時,每個人提交代碼時都會寫 commit message。
每個人都有自己的書寫風格,翻看我們組的git log, 可以說是五花八門,十分不利於閱讀和維護。
一般來說,大廠都有一套的自己的提交規范,尤其是在一些大型開源項目中,commit message 都是十分一致的。
因此,我們需要制定統一標准,促使團隊形成一致的代碼提交風格,更好的提高工作效率,成為一名有追求的工程師。
二、業界通用的 git 提交規范有哪些?
1. commitizen
AngularJS 在 github上 的提交記錄被業內許多人認可,逐漸被大家引用。
格式:
type(scope) : subject
( 1 ) type(必須) : commit 的類別,只允許使用下面幾個標識:
- feat : 新功能
- fix : 修復bug
- docs : 文檔改變
- style : 代碼格式改變
- refactor : 某個已有功能重構
- perf : 性能優化
- test : 增加測試
- build : 改變了build工具 如 grunt換成了 npm
- revert : 撤銷上一次的 commit
- chore : 構建過程或輔助工具的變動
( 2 ) scope(可選) : 用於說明 commit 影響的范圍,比如數據層、控制層、視圖層等等,視項目不同而不同。
( 3 ) subject(必須) : commit 的簡短描述,不超過50個字符。
commitizen 是一個撰寫合格 Commit message 的工具,
遵循 Angular 的提交規范。
安裝:
全局安裝 commitizen
npm install -g commitizen
進入項目文件夾,運行如下命令:
commitizen init cz-conventional-changelog --save --save-exact
使用:
用 git cz
命令取代 git commit
(先使用git add),這時會出現如下選項:
( 1 )選擇 type
( 2 )填寫 scope(選填)
? What is the scope of this change (e.g. component or file name)? (press enter to skip) core
( 3 )填寫 subject
? Write a short, imperative tense description of the change: set a to b
完成,運行 git log
命令,查看我們剛才提交的 commit message,如下:
fix(core): set a to b
優點:
- 符合業內標准(許多項目使用 AngularJS 的commit 規范)
- 提交過程更加規范(使用 commitizen 規范工具,風格統一)
- 能夠生成風格統一的 commit log(type(scope):subject)
缺點:
- 需要安裝 commitizen 工具包,使項目更大、更重了(適合大型開源項目)
- 提交過程受約束較大
- 有一定的學習成本
2. 設置 git commit 模板
步驟如下:
( 1 ) 建立模板文件
在項目中建立 .git_template 文件,內容可以自定義:
type: scope: subject:
( 2 ) 設置模板
運行如下命令:
git config commit.template .git_template // 當前項目
<!-- git config commit.template .git_template // 全局設置 -->
( 3 ) 提交代碼
先使用 git add
添加代碼
使用 git commit
按照模板填寫
最后 git push
推送到遠端
優點:
- 規則可配置,更自由
- 配置方式簡潔(只需添加配置文件)
缺點:
- 便利性差,每次都要用 vim 編輯器填寫模板
- 易出錯,沒有可靠的校驗方式
三、制定適合我們的 git commit 提交規范
第二章中提到的兩種業內普遍使用的規范,都不完全適合我們。
第一種方式適合大型開源項目,我們如果也照搬會比較麻煩,但我們可以借鑒 type(scope): subject 的提交格式,也算是與大廠同步;
第二種方式雖然自由,但是也不比較麻煩,要配置模板。
因此,我們只模仿 type(scope): subject 的提交格式,不使用工具 or 模板校驗,靠大家自覺遵守即可。
格式
type: description
1. type 類型
type 是 commit 的類別,只允許如下幾種標識:
- fix: 修復bug
- add: 新功能
- update: 更新
- style : 代碼格式改變
- test: 增加測試代碼
- revert: 撤銷上一次的commit
- build: 構建工具或構建過程等的變動,如:gulp 換成了 webpack,webpack 升級等
2. description
description 是對本次提交的簡短描述。
不超過50個字符。