Git 提交規(guī)范

git 提交規(guī)范

前言

無規(guī)矩不成方圓,編程也一樣。

如果你有一個(gè)項(xiàng)目,從始至終都是自己寫,那么你想怎么寫都可以,沒有人可以干預(yù)你。可是如果在團(tuán)隊(duì)協(xié)作中,大家都張揚(yáng)個(gè)性,那么代碼將會(huì)是一團(tuán)糟,好好的項(xiàng)目就被糟踐了。不管是開發(fā)還是日后維護(hù),都將是災(zāi)難。

提交規(guī)則

一個(gè)commit只做一件事情,若一個(gè)commit做了多件事情需要拆分成多個(gè)commit
嚴(yán)格遵循commit message格式
每次只允許提交一個(gè)commit,若本地有多個(gè)commit等待提交,必須等前面的commit合并進(jìn)入主版本庫并在本地合并完成后才可提交后面的commit

內(nèi)容要求

在commit log中,要寫清楚以下幾點(diǎn)內(nèi)容:

這個(gè)commit解決了哪個(gè)問題,或者實(shí)現(xiàn)了哪個(gè)功能,需要有對(duì)應(yīng)的bug url或者功能列表url;
如果是個(gè)bug fix,請(qǐng)?jiān)斒鲋按嬖谑裁磫栴},這個(gè)commit是如何解決的;
如果這個(gè)commit只是一個(gè)大的過程中的某一步,請(qǐng)注明,并且簡要列出這個(gè)commit之后還需要做的事情;
如果有需要提醒審核者注意的問題,比如一個(gè)known bug,或者還有某些已知問題,或者需要未來重構(gòu),請(qǐng)用“NOTICE:”另起一行標(biāo)注并說明。

提交格式

Git Commit 規(guī)范可能并沒有那么夸張,但如果你在版本回退的時(shí)候看到一大段糟心的 Commit,恐怕會(huì)懊惱不已吧。所以,嚴(yán)格遵守規(guī)范,利人利己,建議大家養(yǎng)成良好的開發(fā)習(xí)慣。
每次提交,Commit message 都包括三個(gè)部分:header,body 和 footer。

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

其中,header 是必需的,body 和 footer 可以省略。
不管是哪一個(gè)部分,任何一行都不得超過72個(gè)字符(或100個(gè)字符)。這是為了避免自動(dòng)換行影響美觀。

Header

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

type

用于說明 commit 的類別,只允許使用下面7個(gè)標(biāo)識(shí)。

  • 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)

如果type為feat和fix,則該 commit 將肯定出現(xiàn)在 Change log 之中。其他情況(docs、chore、style、refactor、test)由你決定,要不要放入 Change log,建議是不要。

scope

scope用于說明 commit 影響的范圍,比如數(shù)據(jù)層、控制層、視圖層等等,視項(xiàng)目不同而不同。

如果你的修改影響了不止一個(gè)scope,你可以使用*代替。

subject

subject是 commit 目的的簡短描述,不超過50個(gè)字符。

其他注意事項(xiàng):

  • 以動(dòng)詞開頭,使用第一人稱現(xiàn)在時(shí),比如change,而不是changed或changes
  • 第一個(gè)字母小寫
  • 結(jié)尾不加句號(hào)(.)

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):

  • 使用第一人稱現(xiàn)在時(shí),比如使用change而不是changed或changes。
  • 永遠(yuǎn)別忘了第2行是空行
  • 應(yīng)該說明代碼變動(dòng)的動(dòng)機(jī),以及與以前行為的對(duì)比。

Footer

Footer 部分只用于以下兩種情況:

  • 不兼容變動(dòng)
  • 如果當(dāng)前代碼與上一個(gè)版本不兼容,則 Footer 部分以BREAKING CHANGE開頭,后面是對(duì)變動(dòng)的描述、以及變動(dòng)理由和遷移方法。
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,501評(píng)論 6 544
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 99,673評(píng)論 3 429
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,610評(píng)論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,939評(píng)論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 72,668評(píng)論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 56,004評(píng)論 1 329
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,001評(píng)論 3 449
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 43,173評(píng)論 0 290
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,705評(píng)論 1 336
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 41,426評(píng)論 3 359
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 43,656評(píng)論 1 374
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,139評(píng)論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,833評(píng)論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,247評(píng)論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,580評(píng)論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 52,371評(píng)論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 48,621評(píng)論 2 380

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

  • 完整參考實(shí)際項(xiàng)目中實(shí)踐過后,感覺很實(shí)用,檢索起來很方便。 1. 提交規(guī)范的必要性 Git每次提交代碼,需要填寫co...
    PaulLuv閱讀 1,648評(píng)論 0 0
  • 目的 統(tǒng)一團(tuán)隊(duì)Git Commit標(biāo)準(zhǔn),便于后續(xù)代碼review、版本發(fā)布、自動(dòng)化生成change log; 可以...
    Thread_921閱讀 498評(píng)論 0 1
  • 一、為什么需要規(guī)范? 無規(guī)矩不成方圓 如果你有一個(gè)項(xiàng)目團(tuán)隊(duì),從始至終都是自己寫,那么你想怎么寫都可以,沒有人可以干...
    雨中漫步的北極熊閱讀 476評(píng)論 0 0
  • 一章「消失」 正文: nya~大噶好。這篇文章是我第一次寫同人,不足之處請(qǐng)多多指點(diǎn),也希望有更多的人能認(rèn)識(shí)文野認(rèn)識(shí)...
    aya2018閱讀 7,208評(píng)論 1 1
  • 2018年6月2日 星期六 晴 親子日記第161篇 三年級(jí)二班張家俊媽媽 星期六上午兒子有書法課,這是兒子唯一...
    隨緣_子洲媽媽閱讀 199評(píng)論 0 0