最簡Git提交規(guī)范

Git 代碼規(guī)范

Git 每次提交代碼,都是需要寫Commit message(提交說明)火本。一般Commit message 的格式包含三個(gè)部分:

Header -----必填

????type ---必需

????scope --- 可選

????subject ---必需

Body ---- 可省略

Footer ---- 可省略

提交遵循原子性提交原則:每次盡可能最小量提交危队,僅包含一個(gè)不可分割的基本特性、問題修復(fù)或者優(yōu)化提升钙畔,以便于code review / rollback / modification

在實(shí)際提交實(shí)踐的過程中茫陆,大部分時(shí)候僅包含了Herder,提交最簡擎析、最重要的消息簿盅,即 :

Header?= 【Type】+【Subject】


Type

feat:提交新功能

fix:修復(fù)了bug

docs:只修改了文檔

style:調(diào)整代碼格式,未修改代碼邏輯(比如修改空格揍魂、格式化桨醋、缺少分號(hào)等)

refactor:代碼重構(gòu),既沒修復(fù)bug也沒有添加新功能

perf:性能優(yōu)化愉烙,提高性能的代碼更改

test:添加或修改代碼測試

chore:對(duì)構(gòu)建流程或輔助工具和依賴庫(如文檔生成等)的更改


Subject

標(biāo)題是對(duì)變更的簡明描述讨盒,三個(gè)注意點(diǎn):

????使用祈使句,現(xiàn)在時(shí)態(tài)

????不要大寫首字母

????結(jié)尾不要使用句號(hào)


Example

chore: add Oyster build script

docs: explain hat wobble

feat: add beta sequence

fix: remove broken confirmation message

refactor: share logic between 4d3d3d3 and flarhgunnstow

style: convert tabs to spaces

test: ensure Tayne retains clothing



Other

Body?正文是對(duì)標(biāo)題的補(bǔ)充步责,不是必須的返顺,其包含更詳細(xì)的信息,如代碼修改的動(dòng)機(jī)蔓肯、方式遂鹊、與修改前的代碼對(duì)比等等。

Footer?注腳蔗包,通常是BREAKING CHANGE 或修復(fù)bug的鏈接秉扑。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市调限,隨后出現(xiàn)的幾起案子舟陆,更是在濱河造成了極大的恐慌,老刑警劉巖耻矮,帶你破解...
    沈念sama閱讀 217,406評(píng)論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件秦躯,死亡現(xiàn)場離奇詭異,居然都是意外死亡裆装,警方通過查閱死者的電腦和手機(jī)踱承,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,732評(píng)論 3 393
  • 文/潘曉璐 我一進(jìn)店門倡缠,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人茎活,你說我怎么就攤上這事昙沦。” “怎么了载荔?”我有些...
    開封第一講書人閱讀 163,711評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵盾饮,是天一觀的道長。 經(jīng)常有香客問我懒熙,道長丐谋,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,380評(píng)論 1 293
  • 正文 為了忘掉前任煌珊,我火速辦了婚禮号俐,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘定庵。我一直安慰自己吏饿,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,432評(píng)論 6 392
  • 文/花漫 我一把揭開白布蔬浙。 她就那樣靜靜地躺著猪落,像睡著了一般。 火紅的嫁衣襯著肌膚如雪畴博。 梳的紋絲不亂的頭發(fā)上笨忌,一...
    開封第一講書人閱讀 51,301評(píng)論 1 301
  • 那天,我揣著相機(jī)與錄音俱病,去河邊找鬼官疲。 笑死,一個(gè)胖子當(dāng)著我的面吹牛亮隙,可吹牛的內(nèi)容都是我干的途凫。 我是一名探鬼主播,決...
    沈念sama閱讀 40,145評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼溢吻,長吁一口氣:“原來是場噩夢(mèng)啊……” “哼维费!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起促王,我...
    開封第一講書人閱讀 39,008評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤犀盟,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后蝇狼,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體阅畴,經(jīng)...
    沈念sama閱讀 45,443評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,649評(píng)論 3 334
  • 正文 我和宋清朗相戀三年题翰,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了恶阴。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,795評(píng)論 1 347
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡豹障,死狀恐怖冯事,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情血公,我是刑警寧澤昵仅,帶...
    沈念sama閱讀 35,501評(píng)論 5 345
  • 正文 年R本政府宣布,位于F島的核電站累魔,受9級(jí)特大地震影響摔笤,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜垦写,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,119評(píng)論 3 328
  • 文/蒙蒙 一吕世、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧梯投,春花似錦命辖、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,731評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至么鹤,卻和暖如春终娃,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背蒸甜。 一陣腳步聲響...
    開封第一講書人閱讀 32,865評(píng)論 1 269
  • 我被黑心中介騙來泰國打工棠耕, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人柠新。 一個(gè)月前我還...
    沈念sama閱讀 47,899評(píng)論 2 370
  • 正文 我出身青樓昧辽,卻偏偏與公主長得像,于是被迫代替她去往敵國和親登颓。 傳聞我的和親對(duì)象是個(gè)殘疾皇子搅荞,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,724評(píng)論 2 354

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

  • git的規(guī)范和相關(guān)科普知識(shí) git commit 的規(guī)范要求(參考Angular團(tuán)隊(duì)) message格式如下: ...
    達(dá)文西_Huong閱讀 754評(píng)論 0 0
  • commit log規(guī)范的意義: 便于程序員對(duì)提交歷史進(jìn)行追溯,了解發(fā)生了什么情況框咙。 一旦約束了commit me...
    但時(shí)間也偷換概念閱讀 5,181評(píng)論 0 4
  • 1. 前言 目前大部分公司都在使用Git作為版本控制喇嘱,每個(gè)程序員每天都要進(jìn)行代碼的提交茉贡。很多開發(fā)者也包括我自己,有...
    碼農(nóng)小胖哥閱讀 600評(píng)論 0 9
  • 目的 統(tǒng)一團(tuán)隊(duì)Git Commit標(biāo)準(zhǔn)者铜,便于后續(xù)代碼review腔丧、版本發(fā)布放椰、自動(dòng)化生成change log; 可以...
    Thread_921閱讀 490評(píng)論 0 1
  • git 提交規(guī)范 前言 無規(guī)矩不成方圓愉粤,編程也一樣砾医。 如果你有一個(gè)項(xiàng)目,從始至終都是自己寫衣厘,那么你想怎么寫都可以如蚜,...
    janlle閱讀 435評(píng)論 0 1