Git Message 編寫(xiě)指南

我們?cè)谌粘J褂肎it提交代碼時(shí)經(jīng)常會(huì)寫(xiě) commint message胞四,否則就不允許提交刚操。

一般來(lái)說(shuō)闸翅,commit message 應(yīng)該清晰明了,說(shuō)明本次提交的目的菊霜。

目前坚冀,社區(qū)有多種 Commit message 的寫(xiě)法規(guī)范。本文介紹Angular規(guī)范鉴逞,這是目前使用最廣的寫(xiě)法记某,比較合理和系統(tǒng)化司训,并且有配套的工具。

格式化的Commit message 有什么好處液南?

  • 提供更多的歷史信息壳猜,方便快速瀏覽。

  • 可以過(guò)濾某些commit(比如文檔改動(dòng))滑凉,便于快速查找信息统扳。

  • 可以直接從commit生成Change log。

Commit message 規(guī)范說(shuō)明

如果使用 IDEA 開(kāi)發(fā)畅姊,我們可以先裝個(gè)插件: Git Commit Template

裝完之后重啟IDEA咒钟,如果我們提交代碼會(huì)發(fā)現(xiàn)多了一個(gè)按鈕:

image.png

點(diǎn)擊之后就會(huì)出現(xiàn)一個(gè) Commit Template,主要分為下面三個(gè)部分: Header若未, Body朱嘴,F(xiàn)ooter。

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>
image.png

Header

Header的部分只有一行,包括三個(gè)字段: type(必需), scope(可選), subject(必需)

對(duì)應(yīng)到idea插件上圖的配置分別為 Header部分的:

  • type(必需) Type of change commit類(lèi)別
  • scope(可選) Scope of this change commint影響的范圍陨瘩,如功能模塊腕够,或者版本號(hào)
  • subject(必需) Short description 簡(jiǎn)短的描述,如果有Team任務(wù)舌劳,可以寫(xiě)提任務(wù)編號(hào)

type用于說(shuō)明 commit 的類(lèi)別帚湘,只允許使用下面7個(gè)標(biāo)識(shí)

  • feat:新功能(feature)
  • fix:修補(bǔ)bug
  • docs:文檔(documentation)
  • style: 格式(不影響代碼運(yùn)行的變動(dòng),空格,格式化,等等)
  • refactor:重構(gòu)(即不是新增功能,也不是修改bug的代碼變動(dòng))
  • perf: 性能 (提高代碼性能的改變)
  • test:增加測(cè)試或者修改測(cè)試
  • build: 影響構(gòu)建系統(tǒng)或外部依賴(lài)項(xiàng)的更改(maven,gradle,npm 等等)
  • ci: 對(duì)CI配置文件和腳本的更改
  • chore:對(duì)非 src 和 test 目錄的修改
  • revert: Revert a commit

Body

Body 部分是對(duì)本次 commit 的詳細(xì)描述甚淡,可以分成多行大诸。下面是一個(gè)范例。

More detailed explanatory text, if necessary. Wrap it to
about 72 characters or so.

Further paragraphs come after blank lines.

  • Bullet points are okay, too
  • Use a hanging indent

有兩個(gè)注意點(diǎn)贯卦。

(1)使用第一人稱(chēng)現(xiàn)在時(shí)资柔,比如使用change而不是changedchanges

(2)應(yīng)該說(shuō)明代碼變動(dòng)的動(dòng)機(jī)撵割,以及與以前行為的對(duì)比贿堰。

Footer

Footer 部分只用于兩種情況。

不兼容變動(dòng)

如果當(dāng)前代碼與上一個(gè)版本不兼容啡彬,則 Footer 部分以BREAKING CHANGE開(kāi)頭羹与,后面是對(duì)變動(dòng)的描述、以及變動(dòng)理由和遷移方法庶灿。

關(guān)閉 Issue

如果當(dāng)前 commit 針對(duì)某個(gè)issue纵搁,那么可以在 Footer 部分關(guān)閉這個(gè) issue 。

實(shí)例

image.png
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末往踢,一起剝皮案震驚了整個(gè)濱河市腾誉,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖利职,帶你破解...
    沈念sama閱讀 206,839評(píng)論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件趣效,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡猪贪,警方通過(guò)查閱死者的電腦和手機(jī)英支,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,543評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)哮伟,“玉大人,你說(shuō)我怎么就攤上這事妄帘±慊疲” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 153,116評(píng)論 0 344
  • 文/不壞的土叔 我叫張陵抡驼,是天一觀的道長(zhǎng)鬼廓。 經(jīng)常有香客問(wèn)我,道長(zhǎng)致盟,這世上最難降的妖魔是什么碎税? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 55,371評(píng)論 1 279
  • 正文 為了忘掉前任,我火速辦了婚禮馏锡,結(jié)果婚禮上雷蹂,老公的妹妹穿的比我還像新娘。我一直安慰自己杯道,他們只是感情好匪煌,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,384評(píng)論 5 374
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著党巾,像睡著了一般萎庭。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上齿拂,一...
    開(kāi)封第一講書(shū)人閱讀 49,111評(píng)論 1 285
  • 那天驳规,我揣著相機(jī)與錄音,去河邊找鬼署海。 笑死吗购,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的叹侄。 我是一名探鬼主播巩搏,決...
    沈念sama閱讀 38,416評(píng)論 3 400
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼趾代!你這毒婦竟也來(lái)了贯底?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 37,053評(píng)論 0 259
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎禽捆,沒(méi)想到半個(gè)月后笙什,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,558評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡胚想,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,007評(píng)論 2 325
  • 正文 我和宋清朗相戀三年琐凭,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片浊服。...
    茶點(diǎn)故事閱讀 38,117評(píng)論 1 334
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡统屈,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出牙躺,到底是詐尸還是另有隱情愁憔,我是刑警寧澤,帶...
    沈念sama閱讀 33,756評(píng)論 4 324
  • 正文 年R本政府宣布孽拷,位于F島的核電站吨掌,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏脓恕。R本人自食惡果不足惜膜宋,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,324評(píng)論 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望炼幔。 院中可真熱鬧秋茫,春花似錦、人聲如沸乃秀。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 30,315評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)环形。三九已至策泣,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間抬吟,已是汗流浹背萨咕。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 31,539評(píng)論 1 262
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留火本,地道東北人危队。 一個(gè)月前我還...
    沈念sama閱讀 45,578評(píng)論 2 355
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像钙畔,于是被迫代替她去往敵國(guó)和親茫陆。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,877評(píng)論 2 345

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