commit message 規(guī)范

(這段時(shí)間做項(xiàng)目發(fā)現(xiàn)清蚀,多人合作時(shí)或者查看自己修改的以前版本,即使描述很清晰,
一天提交很多版本的情況下苔悦,也要逐一仔細(xì)查看變化,不是很直觀)
下面分享下這兩天用的Commit message 的格式:

1.對(duì)比

before after after
image
image
image

2.前提:

每次本地代碼改動(dòng)提交到遠(yuǎn)程椎咧,需要注明提交說明玖详,否則不允許提交到遠(yuǎn)程

git commit -m "hello word" // -m: 指定hello word

提交多行信息:

git commit // 跳出文本編輯器,寫多行信息

3.commit message 格式

每次提交勤讽,包括三個(gè)部分: header, body, footer

<type>(<scope>): <subject> // 必須

                <body> // 可省略

                <footer> // 可省略

解釋:

type: 提交類別(下面基本會(huì)覆蓋提交代碼所需蟋座,建議只出現(xiàn)下面7種類別,多了會(huì)更亂)

feat:新功能(feature)
fix:修補(bǔ)bug
docs:文檔(documentation)
style: 格式(不影響代碼運(yùn)行的變動(dòng))
refactor:重構(gòu)(即不是新增功能脚牍,也不是修改bug的代碼變動(dòng))
test:增加測(cè)試
chore:構(gòu)建過程或輔助工具的變動(dòng)
scope:影響范圍(可不寫)
subject:對(duì)改變的正常描述向臀,最好以動(dòng)詞開頭語(盡量詳細(xì),必填)
body:詳細(xì)描述(個(gè)人認(rèn)為沒必要诸狭,可不寫)
footer:修改不兼容變動(dòng)以及關(guān)閉 Issue時(shí)(個(gè)人認(rèn)為沒必要券膀,可不寫)

4.撰寫合格 Commit message 的工具----Commitizen

安裝:

npm install -g commitizen

在項(xiàng)目目錄里運(yùn)行

commitizen init cz-conventional-changelog --save --save-exact

END: 以后凡是用git commit命令 就換成 git cz

這樣會(huì)自動(dòng)提示以上幾個(gè)類別

5.建議不必安裝Commitizen工具,自己強(qiáng)制寫幾天就記住這七種類別了作谚,安裝校驗(yàn)反而積累


參考文章:
http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末三娩,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子妹懒,更是在濱河造成了極大的恐慌雀监,老刑警劉巖,帶你破解...
    沈念sama閱讀 217,826評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件眨唬,死亡現(xiàn)場(chǎng)離奇詭異会前,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)匾竿,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,968評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門瓦宜,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人岭妖,你說我怎么就攤上這事临庇》戳В” “怎么了?”我有些...
    開封第一講書人閱讀 164,234評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵假夺,是天一觀的道長(zhǎng)淮蜈。 經(jīng)常有香客問我,道長(zhǎng)已卷,這世上最難降的妖魔是什么梧田? 我笑而不...
    開封第一講書人閱讀 58,562評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮侧蘸,結(jié)果婚禮上裁眯,老公的妹妹穿的比我還像新娘。我一直安慰自己讳癌,他們只是感情好穿稳,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,611評(píng)論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著析桥,像睡著了一般司草。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上泡仗,一...
    開封第一講書人閱讀 51,482評(píng)論 1 302
  • 那天埋虹,我揣著相機(jī)與錄音,去河邊找鬼娩怎。 笑死搔课,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的截亦。 我是一名探鬼主播爬泥,決...
    沈念sama閱讀 40,271評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼崩瓤!你這毒婦竟也來了袍啡?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,166評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤却桶,失蹤者是張志新(化名)和其女友劉穎境输,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體颖系,經(jīng)...
    沈念sama閱讀 45,608評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡嗅剖,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,814評(píng)論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了嘁扼。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片信粮。...
    茶點(diǎn)故事閱讀 39,926評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖趁啸,靈堂內(nèi)的尸體忽然破棺而出强缘,到底是詐尸還是另有隱情督惰,我是刑警寧澤,帶...
    沈念sama閱讀 35,644評(píng)論 5 346
  • 正文 年R本政府宣布欺旧,位于F島的核電站姑丑,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏辞友。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,249評(píng)論 3 329
  • 文/蒙蒙 一震肮、第九天 我趴在偏房一處隱蔽的房頂上張望称龙。 院中可真熱鬧,春花似錦戳晌、人聲如沸鲫尊。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,866評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽疫向。三九已至,卻和暖如春豪嚎,著一層夾襖步出監(jiān)牢的瞬間搔驼,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 32,991評(píng)論 1 269
  • 我被黑心中介騙來泰國(guó)打工侈询, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留舌涨,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,063評(píng)論 3 370
  • 正文 我出身青樓扔字,卻偏偏與公主長(zhǎng)得像囊嘉,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子革为,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,871評(píng)論 2 354

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

  • git 每次提交代碼都會(huì)有message說明本次commit的目的扭粱。 一. commint 介紹 命令 目前,社區(qū)...
    EdmundChen閱讀 11,184評(píng)論 0 5
  • Git 每次提交代碼震檩,都要寫 Commit message(提交說明)琢蛤,否則就不允許提交。 上面代碼的-m參數(shù)恳蹲,就...
    andyJi閱讀 2,834評(píng)論 0 0
  • 前言 Git 每次提交代碼虐块,都要寫 Commit message(提交說明),否則就不允許提交嘉蕾。但是贺奠,一般來說,c...
    guanguans閱讀 126,178評(píng)論 1 63
  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理错忱,服務(wù)發(fā)現(xiàn)儡率,斷路器挂据,智...
    卡卡羅2017閱讀 134,656評(píng)論 18 139
  • 每一次commit是階段性的Ending,應(yīng)記錄著這一階段所完成的事以及關(guān)注點(diǎn)儿普,盡可能詳細(xì)具體崎逃。 注:如果可以的話...
    Jisen閱讀 8,092評(píng)論 2 6