如何規(guī)范你的Git commit?

背景

Git每次提交代碼都需要寫commit message,否則就不允許提交。一般來說,commit message應該清晰明了,說明本次提交的目的,具體做了什么操作……但是在日常開發(fā)中,大家的commit message千奇百怪,中英文混合使用、fix bug等各種籠統(tǒng)的message司空見怪,這就導致后續(xù)代碼維護成本特別大,有時自己都不知道自己的fix bug修改的是什么問題。基于以上這些問題,我們希望通過某種方式來監(jiān)控用戶的git commit message,讓規(guī)范更好的服務于質量,提高大家的研發(fā)效率。

規(guī)范介紹

首先我們可以看下AngularJS 的規(guī)范,它是由 Google 推出的一套提交消息規(guī)范標準,也是目前使用范圍最廣的規(guī)范。有一套合理的手冊也較為系統(tǒng)化;并且還有配套的工具可以供我們使用。

說白了,規(guī)范就是用工具進行強約束。規(guī)范執(zhí)行方案如下:

image

既然有了方案,就會按照某些規(guī)則執(zhí)行,以下是 Google AnguarJS 規(guī)范的要求:

規(guī)范目標

  • 允許通過腳本生成 CHANGELOG.md

  • 可以通過范圍的關鍵詞,快速的搜索到指定版本

git log HEAD --grep feat(package.json) # 在package.json文件里新增的特性。

格式要求

<type>(<scope>): <subject>
  <BLANK LINE>
      <body>
  <BLANK LINE>
<footer>
  • 消息只占用一行,任何行都不能超過 100 個字符

  • 允許使用 GitHub 以及各種 Git 工具閱讀消息

  • 提交消息由頁眉、正文和頁腳組成,由空行分隔

<type>

代表某次提交的類型,比如是修復一個 bug 或是增加一個 feature,類型如下:

image

<scope>

范圍可以是指定提交更改位置的任何內容,如:

  • 對 package.json 文件新增依賴庫,chore(package.json): 新增依賴庫

  • 或對代碼進行重構,refacto(weChat.vue): 重構微信進件

<subject>

如果沒有更合適的范圍,可以直接寫提交內容

規(guī)范建設

初期我們在互聯(lián)網上搜索了大量有關git commit規(guī)范的資料,但只有Angular規(guī)范是目前使用最廣的寫法,比較合理和系統(tǒng)化,并且有配套的工具(IDEA就有插件支持這種寫法)。最后綜合阿里巴巴高德地圖相關部門已有的規(guī)范總結出了一套git commit規(guī)范。

commit message格式

<type>(<scope>): <subject>
image

總結

編碼規(guī)范、流程規(guī)范在軟件開發(fā)過程中是至關重要的,它可以使我們在開發(fā)過程中少走很多彎路。Git commit規(guī)范也是如此,確實也是很有必要的,幾乎不花費額外精力和時間,但在之后查找問題的效率卻很高。作為一名程序員,我們更應注重代碼和流程的規(guī)范性,永遠不要在質量上將就。

首發(fā)地址:如何規(guī)范你的Git commit?

?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,882評論 6 531
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,208評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,746評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,666評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,477評論 6 407
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 54,960評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,047評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,200評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經...
    沈念sama閱讀 48,726評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,617評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,807評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,327評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 44,049評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,425評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,674評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,432評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,769評論 2 372

推薦閱讀更多精彩內容