git提交規則

genetalks_大資料發表於2019-04-04

對於IT人員來說GitHub,相信大家都不陌生,本文主要講解使用Git命令提交時的message規範。對於一個英文水平有限的IT人員在專案中很多時候使用git commit, message往往會寫的不盡如人意,或者當你使用git log時往往不知道之前提交的是什麼東西,修改了什麼,這樣對以後的檢視很不友好。git 提交有一個成熟的工具(Commitizen),本文也將介紹使用(Commitizen)來規範我們的提交資訊。 Commitizen網址: link: www.npmjs.com/package/com…

簡單的使用Commitizen

  1. 安裝Commitizen
npm install -g commitizen
複製程式碼
  1. 進入我們的專案根目錄,執行如下命令:
commitizen init cz-conventional-changelog --save --save-exact
// 之後我們的git commit 都改成git cz
複製程式碼
  1. 每次修改完程式碼後都要先執行
git add '資料夾路徑' //修改後的資料夾,也可以 git add . 來完成本次的新增
複製程式碼
  1. 執行命令git cz 就會出現如下圖所示:

git提交規則

圖中我們可以使用鍵盤的上下鍵去選擇我們本次提交的型別。型別分為:

  • feat:新功能(feature)
  • fix:修補bug
  • docs:文件(documentation)
  • style: 格式(不影響程式碼執行的變動)
  • refactor:重構(即不是新增功能,也不是修改bug的程式碼變動)
  • perf: (改進效能的程式碼更改)

選擇型別之後,命令列提示:

 What is the scope of this change //(可選)
//輸入變化的範圍是什麼,或者變化的檔案
Write a short, imperative tense description of the change: //(可選)
//本次提交簡介
 Provide a longer description of the change: //(可選)
 //本次提交詳細描述
 Are there any breaking changes? //(可選)
 //是否有重大變化(預設為no,為yes的話可以填寫本次重大變化的詳情)
  Does this change affect any open issues?//(可選)
  //是否會影響未解決的問題(預設為no,為yes的話可以填影響的資訊)
複製程式碼

填寫message示例:

git提交規則

push到GitHub後的效果如圖:

git提交規則

這樣我們的commit message就比較直觀。

參考文獻


作者資訊:寧文飛,人和未來大資料前端工程師

相關文章