git提交規(guī)范說明

h3. 清晰的代碼提交規(guī)范米绕,有利于我們代碼方便的查找和維護馋艺。可以約定提交格式如下:

--------------------- 格式start -----------------------

<type>[scope]: <subject>
空一行
[可選的正文 body]
空一行
[可選的頁腳 footer]

---------------------- 格式end-----------------------

  • type:
    提交類型碱鳞,必填項窿给,詳細可以分為:

feat: 新功能feature
fix:修復bug
docs: 文檔注釋
style:代碼格式率拒,不影響代碼運行的變動
refactor:重構(gòu)、優(yōu)化(既不增加新功能也不修復bug)
perf:性能優(yōu)化
test:增加測試
chore:構(gòu)建過程或者輔助工具的變動
revert:回退
build:打包
ci:與ci 持續(xù)集成有關的改動
temp:臨時代碼角撞,不計入 CHANGELOG勃痴,比如必須部署到某種環(huán)境才能測試的變更。如測試真機上 transparent title 啟動參數(shù)是否設置成功

  • scope:

scope也是必填項劣领,用于描述改動范圍铁材,格式一般為 項目名/模塊名 例如:
node-pc/common
如果一次commit修改多個模塊奕锌,建議拆分為多次commit村生,以便更好的追蹤和維護。

  • subject:

填寫簡單的提交說明缴守,言簡意賅镇辉,不超過50字,可以清晰明了的指出修改的意圖忽肛。

  • body:

選填烂斋,用于填寫更詳細的描述。主要描述改動之前的情況和修改動機罕模,對于小的修改可以沒有帘瞭,但是重大需求淑掌、更新等必須添加body來作說明。

  • footer:

選填蝶念,用填寫關聯(lián)的issus抛腕,或者BREAK CHANGE.
必須是大寫,表示引入了破壞性 API 變更媒殉,通常是一個大版本的改動担敌,BREAKING CHANGE: 之后必須提供描述,下面一個包含破壞性變更的提交示例:

feat: allow provided config object to extend other configs

BREAKING CHANGE:extendskey in config file is now used for extending other config files

當然廷蓉,一方面規(guī)范需要大家都自覺遵守全封,但是使用現(xiàn)有的工具來約束規(guī)范可以達到事半功倍的效果。所以針對不同的開發(fā)環(huán)境可以選擇合適自己的代碼提交規(guī)范格式化工具桃犬,利用git hooks來約束提交規(guī)范售貌。 __

?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市疫萤,隨后出現(xiàn)的幾起案子颂跨,更是在濱河造成了極大的恐慌扯饶,老刑警劉巖钓丰,帶你破解...
    沈念sama閱讀 206,723評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異李茫,居然都是意外死亡魄宏,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,485評論 2 382
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來券册,“玉大人,你說我怎么就攤上這事考阱。” “怎么了吃既?”我有些...
    開封第一講書人閱讀 152,998評論 0 344
  • 文/不壞的土叔 我叫張陵冀惭,是天一觀的道長。 經(jīng)常有香客問我乐尊,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,323評論 1 279
  • 正文 為了忘掉前任牺弄,我火速辦了婚禮蛇捌,結(jié)果婚禮上俭驮,老公的妹妹穿的比我還像新娘混萝。我一直安慰自己逸嘀,他們只是感情好,可當我...
    茶點故事閱讀 64,355評論 5 374
  • 文/花漫 我一把揭開白布悉患。 她就那樣靜靜地躺著坞淮,像睡著了一般晃跺。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上烹玉,一...
    開封第一講書人閱讀 49,079評論 1 285
  • 那天掂榔,我揣著相機與錄音瑞信,去河邊找鬼。 笑死秤涩,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的浊竟。 我是一名探鬼主播,決...
    沈念sama閱讀 38,389評論 3 400
  • 文/蒼蘭香墨 我猛地睜開眼后频,長吁一口氣:“原來是場噩夢啊……” “哼膏执!你這毒婦竟也來了更米?” 一聲冷哼從身側(cè)響起消请,我...
    開封第一講書人閱讀 37,019評論 0 259
  • 序言:老撾萬榮一對情侶失蹤针饥,失蹤者是張志新(化名)和其女友劉穎修肠,沒想到半個月后饲化,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體吗伤,經(jīng)...
    沈念sama閱讀 43,519評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡巢块,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 35,971評論 2 325
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了丹鸿。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,100評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖肋殴,靈堂內(nèi)的尸體忽然破棺而出区丑,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 33,738評論 4 324
  • 正文 年R本政府宣布宴杀,位于F島的核電站绢记,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏叉讥。R本人自食惡果不足惜判耕,卻給世界環(huán)境...
    茶點故事閱讀 39,293評論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望檬果。 院中可真熱鬧瓮孙,春花似錦、人聲如沸选脊。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,289評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽恳啥。三九已至偏灿,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間钝的,已是汗流浹背翁垂。 一陣腳步聲響...
    開封第一講書人閱讀 31,517評論 1 262
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留扁藕,地道東北人沮峡。 一個月前我還...
    沈念sama閱讀 45,547評論 2 354
  • 正文 我出身青樓,卻偏偏與公主長得像亿柑,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子棍弄,可洞房花燭夜當晚...
    茶點故事閱讀 42,834評論 2 345

推薦閱讀更多精彩內(nèi)容

  • 代碼提交規(guī)范 type 提交類型(required) 每個提交都必須使用類型字段前綴望薄,它由一個名詞組成,諸如 fe...
    JSleefat閱讀 310評論 0 1
  • git是現(xiàn)在市面上最流行的版本控制工具呼畸,書寫良好的commit message能大大提高代碼維護的效率痕支。但是在日常...
    涅槃快樂是金閱讀 2,703評論 0 12
  • git 提交規(guī)范 前言 無規(guī)矩不成方圓,編程也一樣蛮原。 如果你有一個項目卧须,從始至終都是自己寫,那么你想怎么寫都可以,...
    janlle閱讀 421評論 0 1
  • Git代碼提交規(guī)范 前言 為什么要注重代碼提交規(guī)范花嘶? 在團隊協(xié)作開發(fā)時笋籽,每個人提交代碼時都會寫 commit me...
    keyuan0214閱讀 5,276評論 0 3
  • git的規(guī)范和相關科普知識 git commit 的規(guī)范要求(參考Angular團隊) message格式如下: ...
    達文西_Huong閱讀 748評論 0 0