git提交規(guī)范

Git 提交規(guī)范

制定一個 git commit 信息的提交規(guī)范是開發(fā)團隊工作流必不可少的環(huán)節(jié)鞠绰。試想一下碾篡,如果查看主分支上的歷史庫也就是你查看 git log 的時候,打印出來的信息雜亂無章的話,如果代碼遇到問題,可能需要很大的精力與成本來查找到導致問題的代碼提交拔疚,所以團隊需要制定規(guī)范來引導成員編寫規(guī)范的 commit 信息。

接下來的 commit 信息規(guī)范參考了 angularjs 團隊的開發(fā)者指引與筆者的工作團隊進行總結(jié)既荚,讀者如有需要可以以此為基礎(chǔ)增加或修改成為自己團隊的 commit 規(guī)范的一部分稚失。

提交信息基本模板

如果 commit 信息都按照一定的模式進行提交,那么我們就會很容易找到自己想要的信息恰聘,模板參考如下:

<type>(<scope>): <subject> [<ISSUE_ID>]
<body>
<footer>

commit 信息包括三個字段: type (必需)句各, scope(可選) 和 subject(必需):

  1. type吸占。type 是用于說明該 commit 的類型的,一般我們會規(guī)定 type 的類型如下:
  • feat: 新功能(feature)
  • fix: 修復 bug
  • docs: 文檔(documents)
  • style: 代碼格式(不影響代碼運行的格式變動诫钓,注意不是指 CSS 的修改)
  • refactor: 重構(gòu)(既不是新增功能旬昭,也不是修改 bug 的代碼變動)
  • test: 提交測試代碼(單元測試篙螟,集成測試等)
  • chore: 構(gòu)建或輔助工具的變動
  • misc: 一些未歸類或不知道將它歸類到什么方面的提交
  1. scope菌湃。scope 說明 commit 影響的范圍,比如數(shù)據(jù)層遍略,控制層惧所,視圖層等等,這個需要視具體場景與項目的不同而靈活變動

  2. subject绪杏。subject 是對于該 commit 目的的簡短描述

  • 使用第一人稱現(xiàn)在時的動詞開頭下愈,比如 modify 而不是 modified 或 modifies
  • 首字母小寫,并且結(jié)尾不加句號
  1. ISSUEE_ID蕾久。這個與公司的需求管理與項目管理有關(guān)势似,假設你的項目放在 github 上,你的需求或者 bug 修復可能會有對應的 issues 記錄僧著,你可以加到你的 commit 信息中如 issue-37938634履因。
    body 其實就是 subject 的詳細說明,而 footer 中你可以填寫相關(guān)的需求管理 issues id盹愚。

參考:

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

[2] https://www.conventionalcommits.org/en/v1.0.0/

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末栅迄,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子皆怕,更是在濱河造成了極大的恐慌毅舆,老刑警劉巖,帶你破解...
    沈念sama閱讀 222,681評論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件愈腾,死亡現(xiàn)場離奇詭異憋活,居然都是意外死亡,警方通過查閱死者的電腦和手機虱黄,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,205評論 3 399
  • 文/潘曉璐 我一進店門悦即,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人礁鲁,你說我怎么就攤上這事盐欺。” “怎么了仅醇?”我有些...
    開封第一講書人閱讀 169,421評論 0 362
  • 文/不壞的土叔 我叫張陵冗美,是天一觀的道長。 經(jīng)常有香客問我析二,道長粉洼,這世上最難降的妖魔是什么节预? 我笑而不...
    開封第一講書人閱讀 60,114評論 1 300
  • 正文 為了忘掉前任,我火速辦了婚禮属韧,結(jié)果婚禮上安拟,老公的妹妹穿的比我還像新娘。我一直安慰自己宵喂,他們只是感情好糠赦,可當我...
    茶點故事閱讀 69,116評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著锅棕,像睡著了一般拙泽。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上裸燎,一...
    開封第一講書人閱讀 52,713評論 1 312
  • 那天顾瞻,我揣著相機與錄音,去河邊找鬼德绿。 笑死荷荤,一個胖子當著我的面吹牛,可吹牛的內(nèi)容都是我干的移稳。 我是一名探鬼主播蕴纳,決...
    沈念sama閱讀 41,170評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼秒裕!你這毒婦竟也來了袱蚓?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 40,116評論 0 277
  • 序言:老撾萬榮一對情侶失蹤几蜻,失蹤者是張志新(化名)和其女友劉穎喇潘,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體梭稚,經(jīng)...
    沈念sama閱讀 46,651評論 1 320
  • 正文 獨居荒郊野嶺守林人離奇死亡颖低,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,714評論 3 342
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了弧烤。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片忱屑。...
    茶點故事閱讀 40,865評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖暇昂,靈堂內(nèi)的尸體忽然破棺而出莺戒,到底是詐尸還是另有隱情,我是刑警寧澤急波,帶...
    沈念sama閱讀 36,527評論 5 351
  • 正文 年R本政府宣布从铲,位于F島的核電站,受9級特大地震影響澄暮,放射性物質(zhì)發(fā)生泄漏名段。R本人自食惡果不足惜阱扬,卻給世界環(huán)境...
    茶點故事閱讀 42,211評論 3 336
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望伸辟。 院中可真熱鬧麻惶,春花似錦、人聲如沸信夫。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,699評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽忙迁。三九已至脐彩,卻和暖如春碎乃,著一層夾襖步出監(jiān)牢的瞬間姊扔,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,814評論 1 274
  • 我被黑心中介騙來泰國打工梅誓, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留恰梢,地道東北人。 一個月前我還...
    沈念sama閱讀 49,299評論 3 379
  • 正文 我出身青樓梗掰,卻偏偏與公主長得像嵌言,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子及穗,可洞房花燭夜當晚...
    茶點故事閱讀 45,870評論 2 361

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