Git提交規(guī)范化

目的

  • 統(tǒng)一團(tuán)隊(duì)Git Commit標(biāo)準(zhǔn),便于后續(xù)代碼review、版本發(fā)布博个、自動(dòng)化生成change log
  • 可以提供更多更有效的歷史信息际乘,方便快速預(yù)覽以及配合cherry-pick快速合并代碼坡倔;
  • 團(tuán)隊(duì)其他成員進(jìn)行類git blame時(shí)可以快速明白代碼用意;

Git版本規(guī)范

分支

master分支為主分支(保護(hù)分支),不能直接在master上進(jìn)行修改代碼和提交罪塔;
develop分支為測(cè)試分支投蝉,所以開發(fā)完成需要提交測(cè)試的功能合并到該分支;
feature分支為開發(fā)分支征堪,大家根據(jù)不同需求創(chuàng)建獨(dú)立的功能分支瘩缆,開發(fā)完成后合并到develop分支;
fix分支為bug修復(fù)分支佃蚜,需要根據(jù)實(shí)際情況對(duì)已發(fā)布的版本進(jìn)行漏洞修復(fù)庸娱;

Tag

采用三段式,v版本.里程碑.序號(hào)谐算,如v1.2.1

架構(gòu)升級(jí)或架構(gòu)重大調(diào)整熟尉,修改第2位
新功能上線或者模塊大的調(diào)整,修改第2位
bug修復(fù)上線洲脂,修改第3位

changelog

版本正式發(fā)布后斤儿,需要生產(chǎn)changelog文檔,便于后續(xù)問題追溯恐锦。

image.png

Git提交信息

message信息格式采用目前主流的Angular規(guī)范往果,這是目前使用最廣的寫法,比較合理和系統(tǒng)化一铅,并且有配套的工具陕贮。

commit message格式說明

Commit message一般包括三部分:HeaderBodyFooter潘飘。

Header

type(scope):subject

  • type:用于說明commit的類別肮之,規(guī)定為如下幾種
    • feat:新增功能;
    • fix:修復(fù)bug福也;
    • docs:修改文檔局骤;
    • refactor:代碼重構(gòu),未新增任何功能和修復(fù)任何bug暴凑;
    • build:改變構(gòu)建流程峦甩,新增依賴庫(kù)、工具等(例如webpack修改)现喳;
    • style:僅僅修改了空格凯傲、縮進(jìn)等,不改變代碼邏輯嗦篱;
    • perf:改善性能和體現(xiàn)的修改冰单;
    • chore:非srctest的修改;
    • test:測(cè)試用例的修改灸促;
    • ci:自動(dòng)化流程配置修改诫欠;
    • revert:回滾到上一個(gè)版本涵卵;
  • scope:【可選】用于說明commit的影響范圍
  • subjectcommit的簡(jiǎn)要說明,盡量簡(jiǎn)短

Body

對(duì)本次commit的詳細(xì)描述荒叼,可分多行

Footer

不兼容變動(dòng):需要描述相關(guān)信息
關(guān)閉指定Issue:輸入Issue信息


如有誤點(diǎn)轿偎,多多指教 喜歡呦~

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市被廓,隨后出現(xiàn)的幾起案子坏晦,更是在濱河造成了極大的恐慌,老刑警劉巖嫁乘,帶你破解...
    沈念sama閱讀 217,084評(píng)論 6 503
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件昆婿,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡蜓斧,警方通過查閱死者的電腦和手機(jī)仓蛆,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,623評(píng)論 3 392
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來挎春,“玉大人多律,你說我怎么就攤上這事÷眩” “怎么了?”我有些...
    開封第一講書人閱讀 163,450評(píng)論 0 353
  • 文/不壞的土叔 我叫張陵辽装,是天一觀的道長(zhǎng)帮碰。 經(jīng)常有香客問我,道長(zhǎng)拾积,這世上最難降的妖魔是什么殉挽? 我笑而不...
    開封第一講書人閱讀 58,322評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮拓巧,結(jié)果婚禮上斯碌,老公的妹妹穿的比我還像新娘。我一直安慰自己肛度,他們只是感情好傻唾,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,370評(píng)論 6 390
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著承耿,像睡著了一般冠骄。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上加袋,一...
    開封第一講書人閱讀 51,274評(píng)論 1 300
  • 那天凛辣,我揣著相機(jī)與錄音,去河邊找鬼职烧。 笑死扁誓,一個(gè)胖子當(dāng)著我的面吹牛防泵,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播蝗敢,決...
    沈念sama閱讀 40,126評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼捷泞,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了前普?” 一聲冷哼從身側(cè)響起肚邢,我...
    開封第一講書人閱讀 38,980評(píng)論 0 275
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎拭卿,沒想到半個(gè)月后骡湖,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,414評(píng)論 1 313
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡峻厚,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,599評(píng)論 3 334
  • 正文 我和宋清朗相戀三年响蕴,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片惠桃。...
    茶點(diǎn)故事閱讀 39,773評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡浦夷,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出辜王,到底是詐尸還是另有隱情劈狐,我是刑警寧澤,帶...
    沈念sama閱讀 35,470評(píng)論 5 344
  • 正文 年R本政府宣布呐馆,位于F島的核電站肥缔,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏汹来。R本人自食惡果不足惜续膳,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,080評(píng)論 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望收班。 院中可真熱鬧坟岔,春花似錦、人聲如沸摔桦。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,713評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)酣溃。三九已至瘦穆,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間赊豌,已是汗流浹背扛或。 一陣腳步聲響...
    開封第一講書人閱讀 32,852評(píng)論 1 269
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留碘饼,地道東北人熙兔。 一個(gè)月前我還...
    沈念sama閱讀 47,865評(píng)論 2 370
  • 正文 我出身青樓悲伶,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親住涉。 傳聞我的和親對(duì)象是個(gè)殘疾皇子麸锉,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,689評(píng)論 2 354

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

  • Git 規(guī)范 所有使用了本規(guī)范的項(xiàng)目,必須嚴(yán)格規(guī)范操作舆声,否則不予以合并代碼花沉、提測(cè)、打包上線等后續(xù)操作媳握。 基本要求 ...
    zgsddzwj閱讀 13,604評(píng)論 1 14
  • Git常用語(yǔ)法 [TOC] Git簡(jiǎn)介 描述 ? Git(讀音為/g?t/碱屁。)是一個(gè)開源的分布式版本控制系統(tǒng),...
    君惜丶閱讀 3,511評(píng)論 0 13
  • 多種多樣的工作流使得在項(xiàng)目中實(shí)施Git時(shí)變得難以選擇蛾找。這份教程提供了一個(gè)出發(fā)點(diǎn)娩脾,調(diào)查企業(yè)團(tuán)隊(duì)最常見的Git工作流。...
    JSErik閱讀 4,403評(píng)論 2 8
  • 都說這個(gè)很難做到打毛,你瞅瞅柿赊!都說這個(gè)很難做到,你瞅瞅幻枉!都說這個(gè)很難做到碰声,你瞅瞅!都說這個(gè)很難做到熬甫,你瞅瞅奥邮!都說這個(gè)很...
    張三爺123閱讀 241評(píng)論 0 0
  • 年少輕狂 年少莽撞 年少無畏 無迷惘 朝如烈陽(yáng) 暮如海浪 心懷執(zhí)念 盼遠(yuǎn)方 妄欲如風(fēng) 貪欲如霜 善惡因果 被遺忘 ...
    洛瑾闌閱讀 372評(píng)論 0 1