一、為什麼需要制定提交規範?
在團隊協作開發時,每個人提交程式碼時都會寫 commit message。
每個人都有自己的書寫風格,翻看我們組的git log, 可以說是五花八門,十分不利於閱讀和維護。
一般來說,大廠都有一套的自己的提交規範,尤其是在一些大型開源專案中,commit message 都是十分一致的。
因此,我們需要制定統一標準,促使團隊形成一致的程式碼提交風格,更好的提高工作效率,成為一名有追求的工程師。
二、業界通用的 git 提交規範有哪些?1. commitizenAngularJS 在 github上 的提交記錄被業內許多人認可,逐漸被大家引用。
格式:type(scope) : subject
( 1 ) type(必須) : commit 的類別,只允許使用下面幾個標識:
feat : 新功能fix : 修復bugdocs : 文件改變style : 程式碼格式改變refactor : 某個已有功能重構perf : 效能最佳化test : 增加測試build : 改變了build工具 如 grunt換成了 npmrevert : 撤銷上一次的 commitchore : 構建過程或輔助工具的變動( 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 ) 設定模板執行如下命令:
優點:規則可配置,更自由配置方式簡潔(只需新增配置檔案)缺點:便利性差,每次都要用 vim 編輯器填寫模板易出錯,沒有可靠的校驗方式三、制定適合我們的 git commit 提交規範第二章中提到的兩種業內普遍使用的規範,都不完全適合我們。
第一種方式適合大型開源專案,我們如果也照搬會比較麻煩,但我們可以借鑑 type(scope): subject 的提交格式,也算是與大廠同步;第二種方式雖然自由,但是也不比較麻煩,要配置模板。因此,我們只模仿 type(scope): subject 的提交格式,不使用工具 or 模板校驗,靠大家自覺遵守即可。
格式type: description
1. type 型別type 是 commit 的類別,只允許如下幾種標識:
fix: 修復bugadd: 新功能update: 更新style : 程式碼格式改變test: 增加測試程式碼revert: 撤銷上一次的commitbuild: 構建工具或構建過程等的變動,如:gulp 換成了 webpack,webpack 升級等2. descriptiondescription 是對本次提交的簡短描述。
不超過50個字元。