Git commit message格式規(guī)范(推薦)

Git commit message格式規(guī)范(推薦)

<type>(<scope>): <subject>
<BLANK LINE> 空格
<body>
<BLANK LINE> 空格
<footer>

type(必須)

用于說(shuō)明git commit的類別毙籽,只允許使用下面的標(biāo)識(shí)

  1. feat:新功能(feature)详拙。
  2. fix/to:修復(fù)bug
  3. docs:文檔(documentation)徽龟。
  4. style:格式(不影響代碼運(yùn)行的變動(dòng))疑俭。
  5. refactor:重構(gòu)(即不是新增功能几蜻,也不是修改bug的代碼變動(dòng))姻锁。
  6. perf:優(yōu)化相關(guān)寞冯,比如提升性能渴析、體驗(yàn)。
  7. test:增加測(cè)試吮龄。
  8. chore:構(gòu)建過(guò)程或輔助工具的變動(dòng)俭茧。
  9. revert:回滾到上一個(gè)版本。
  10. merge:代碼合并漓帚。
  11. sync:同步主線或分支的Bug母债。

scope(可選)
scope用于說(shuō)明 commit 影響的范圍,比如數(shù)據(jù)層尝抖、控制層毡们、視圖層等等,視項(xiàng)目不同而不同昧辽。
例如在Angular衙熔,可以是location,browser搅荞,compile红氯,compile,rootScope咕痛, ngHref痢甘,ngClick,ngView等茉贡。
如果你的修改影響了不止一個(gè)scope塞栅,你可以使用*代替。

subject(必須)
subject是commit目的的簡(jiǎn)短描述腔丧,不超過(guò)50個(gè)字符(超過(guò)可以再body 里進(jìn)行說(shuō)明)构蹬。

  • 建議使用中文(感覺(jué)中國(guó)人用中文描述問(wèn)題能更清楚一些)。
  • 結(jié)尾不加句號(hào)或其他標(biāo)點(diǎn)符號(hào)悔据。

body(可選) :

改動(dòng)的動(dòng)機(jī),詳細(xì)描述等

footer (可選) :需求鏈接狀態(tài)變化 (Closes #392)

這樣規(guī)范git commit到底有哪些好處呢俗壹?

  • 便于程序員對(duì)提交歷史進(jìn)行追溯科汗,了解發(fā)生了什么情況。
  • 一旦約束了commit message绷雏,意味著我們將慎重的進(jìn)行每一次提交头滔,不能再一股腦的把各種各樣的改動(dòng)都放在一個(gè)git commit里面怖亭,這樣一來(lái)整個(gè)代碼改動(dòng)的歷史也將更加清晰。
  • 格式化的commit message才可以用于自動(dòng)化輸出Change log坤检。

Examples :

feat($browser): onUrlChange event (popstate/hashchange/polling)

Added new event to $browser:

  • forward popstate event if available

  • forward hashchange event if popstate not available

  • do polling when neither popstate nor hashchange available

Closes #1213242

fix($compile): couple of unit tests for IE9

Older IEs serialize html uppercased, but IE9 does not...

Would be better to expect case insensitive, unfortunately jasmine does

not allow to user regexps for throw expectations.

Closes #17116

參考 :

angularJS :
https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines

https://www.cnblogs.com/zhouqx979/p/13783425.html

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末兴猩,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子早歇,更是在濱河造成了極大的恐慌倾芝,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,188評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件箭跳,死亡現(xiàn)場(chǎng)離奇詭異晨另,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)谱姓,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,464評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門借尿,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人屉来,你說(shuō)我怎么就攤上這事路翻。” “怎么了茄靠?”我有些...
    開(kāi)封第一講書人閱讀 165,562評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵茂契,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我嘹黔,道長(zhǎng)账嚎,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書人閱讀 58,893評(píng)論 1 295
  • 正文 為了忘掉前任儡蔓,我火速辦了婚禮郭蕉,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘喂江。我一直安慰自己召锈,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,917評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布获询。 她就那樣靜靜地躺著涨岁,像睡著了一般。 火紅的嫁衣襯著肌膚如雪吉嚣。 梳的紋絲不亂的頭發(fā)上梢薪,一...
    開(kāi)封第一講書人閱讀 51,708評(píng)論 1 305
  • 那天,我揣著相機(jī)與錄音尝哆,去河邊找鬼秉撇。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的琐馆。 我是一名探鬼主播规阀,決...
    沈念sama閱讀 40,430評(píng)論 3 420
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼瘦麸!你這毒婦竟也來(lái)了谁撼?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書人閱讀 39,342評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤滋饲,失蹤者是張志新(化名)和其女友劉穎厉碟,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體了赌,經(jīng)...
    沈念sama閱讀 45,801評(píng)論 1 317
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡墨榄,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,976評(píng)論 3 337
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了勿她。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片袄秩。...
    茶點(diǎn)故事閱讀 40,115評(píng)論 1 351
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖逢并,靈堂內(nèi)的尸體忽然破棺而出之剧,到底是詐尸還是另有隱情,我是刑警寧澤砍聊,帶...
    沈念sama閱讀 35,804評(píng)論 5 346
  • 正文 年R本政府宣布背稼,位于F島的核電站,受9級(jí)特大地震影響玻蝌,放射性物質(zhì)發(fā)生泄漏蟹肘。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,458評(píng)論 3 331
  • 文/蒙蒙 一俯树、第九天 我趴在偏房一處隱蔽的房頂上張望帘腹。 院中可真熱鬧,春花似錦许饿、人聲如沸阳欲。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 32,008評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)球化。三九已至,卻和暖如春瓦糟,著一層夾襖步出監(jiān)牢的瞬間筒愚,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 33,135評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工菩浙, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留锨能,地道東北人扯再。 一個(gè)月前我還...
    沈念sama閱讀 48,365評(píng)論 3 373
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像址遇,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子斋竞,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,055評(píng)論 2 355