GIT規(guī)范

GIT 規(guī)范

合并規(guī)范

為適應(yīng)多個feature同時并行交錯開發(fā)单起,做到每個 feature 獨(dú)立干凈东囚、合并的代碼不被意外覆蓋浴麻,這里有幾個良好的代碼合并習(xí)慣(規(guī)范)供大家參考够吩,

  • 為了讓代碼變化更好追蹤栅盲,總是使用 merge 操作 而非 rebase
  • 總是在自己的 開發(fā)(feature)分支 修改代碼废恋,無論開發(fā)階段還是解決bug階段谈秫;
  • 每當(dāng)需要部署時,請切換到 部署分支鱼鼓,比如 test拟烫,merge 您的 開發(fā)(feature)分支 代碼到 test;請不要將您的環(huán)境變量配置一起合并過去迄本;
  • 您不需要將 部署分支 同步(merge)到您的 開發(fā)(feature)分支硕淑,它會污染您的代碼。

這樣做的好處是:您的feature分支代碼總是獨(dú)立干凈的嘉赎,多人開發(fā)時置媳,可以靈活選擇哪幾個 feature 上線,擁抱產(chǎn)品需求變化

提交規(guī)范

commit message格式

type(scope): subject

type(必須) :

用于說明git commit的類別公条,只允許使用下面的標(biāo)識拇囊。

  • feat:新功能(feature)。
  • fix:修復(fù)bug靶橱,可以是QA發(fā)現(xiàn)的BUG寥袭,也可以是研發(fā)自己發(fā)現(xiàn)的BUG。
  • chore:構(gòu)建過程或輔助工具的維護(hù)关霸。
  • refactor:重構(gòu)(即不是新增功能传黄,也不是修改bug的代碼變動)。
  • docs:文檔(documentation)队寇。
  • style:格式(不影響代碼運(yùn)行的變動)膘掰。
  • perf:優(yōu)化相關(guān),比如提升性能佳遣、體驗识埋。
  • test:增加測試啤覆。
  • revert:回滾到上一個版本。
  • ci:持續(xù)集成相關(guān)惭聂。

scope(可選)

scope用于說明 commit 影響的范圍窗声,比如權(quán)限、訂單辜纲、商品等等笨觅,視項目不同而不同。

feat(order)

subject(必須)

subject是commit目的的簡短描述耕腾,不超過50個字符见剩。

fix(product): 修復(fù)產(chǎn)品無法刪除 Refs #133

部署上線

保持 master 分支是線上穩(wěn)定版本, 該分支是受保護(hù)的

統(tǒng)一使用 tag 的形式扫俺,發(fā)布上線:

git tag -a v1.0.0 -m "v1.0.0:一些相關(guān)描述苍苞,解決了xxx,修復(fù)了xxx"

# push tag
git push origin v1.0.0

打 tag 形式對運(yùn)維操作友好狼纬,tag 能準(zhǔn)確的指向 commit id羹呵,回滾方便;這里我們以版本號格式標(biāo)記疗琉,版本號可以同步產(chǎn)品的版本冈欢,也可以開發(fā)自己維護(hù)。
常見使用3個整數(shù)來記錄版本號 major.minor.patch盈简,比如 1.2.3

  • major 主版本號:大改版凑耻,不兼容老版本,major+1
  • minor 次版本號:普通迭代柠贤,不影響之前版本功能香浩,minor+1
  • patch 補(bǔ)丁版本號:小修改,bug修復(fù)臼勉,patch+1

打完 tag 后邻吭,將tag名 告知運(yùn)維,運(yùn)維做線上發(fā)布坚俗;
發(fā)布完成后镜盯,線上驗證完成,運(yùn)維或項目Owner/Maintainer 做合并到 master 分支操作

??:視情況 tagName 用 newBranch / commitId 代替

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末猖败,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子降允,更是在濱河造成了極大的恐慌恩闻,老刑警劉巖,帶你破解...
    沈念sama閱讀 219,039評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件剧董,死亡現(xiàn)場離奇詭異幢尚,居然都是意外死亡破停,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,426評論 3 395
  • 文/潘曉璐 我一進(jìn)店門尉剩,熙熙樓的掌柜王于貴愁眉苦臉地迎上來真慢,“玉大人,你說我怎么就攤上這事理茎『诮纾” “怎么了?”我有些...
    開封第一講書人閱讀 165,417評論 0 356
  • 文/不壞的土叔 我叫張陵皂林,是天一觀的道長朗鸠。 經(jīng)常有香客問我,道長础倍,這世上最難降的妖魔是什么掏击? 我笑而不...
    開封第一講書人閱讀 58,868評論 1 295
  • 正文 為了忘掉前任犁功,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘刃泌。我一直安慰自己,他們只是感情好雀监,可當(dāng)我...
    茶點故事閱讀 67,892評論 6 392
  • 文/花漫 我一把揭開白布戚哎。 她就那樣靜靜地躺著,像睡著了一般浦辨。 火紅的嫁衣襯著肌膚如雪蹬竖。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,692評論 1 305
  • 那天流酬,我揣著相機(jī)與錄音币厕,去河邊找鬼。 笑死芽腾,一個胖子當(dāng)著我的面吹牛旦装,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播摊滔,決...
    沈念sama閱讀 40,416評論 3 419
  • 文/蒼蘭香墨 我猛地睜開眼阴绢,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了艰躺?” 一聲冷哼從身側(cè)響起呻袭,我...
    開封第一講書人閱讀 39,326評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎腺兴,沒想到半個月后左电,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,782評論 1 316
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,957評論 3 337
  • 正文 我和宋清朗相戀三年篓足,在試婚紗的時候發(fā)現(xiàn)自己被綠了段誊。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,102評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡栈拖,死狀恐怖连舍,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情涩哟,我是刑警寧澤索赏,帶...
    沈念sama閱讀 35,790評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站染簇,受9級特大地震影響参滴,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜锻弓,卻給世界環(huán)境...
    茶點故事閱讀 41,442評論 3 331
  • 文/蒙蒙 一砾赔、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧青灼,春花似錦暴心、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,996評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至弹沽,卻和暖如春檀夹,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背策橘。 一陣腳步聲響...
    開封第一講書人閱讀 33,113評論 1 272
  • 我被黑心中介騙來泰國打工炸渡, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人丽已。 一個月前我還...
    沈念sama閱讀 48,332評論 3 373
  • 正文 我出身青樓蚌堵,卻偏偏與公主長得像,于是被迫代替她去往敵國和親沛婴。 傳聞我的和親對象是個殘疾皇子吼畏,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,044評論 2 355

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

  • Git 規(guī)范 所有使用了本規(guī)范的項目,必須嚴(yán)格規(guī)范操作嘁灯,否則不予以合并代碼泻蚊、提測、打包上線等后續(xù)操作旁仿。 基本要求 ...
    zgsddzwj閱讀 13,622評論 1 14
  • 導(dǎo)讀 為了避免歧義藕夫,文檔大量使用了「能愿動詞」孽糖,對應(yīng)的解釋如下:必須(Must) - 只能這樣子做枯冈,請無條件遵循毅贮,...
    suuredthed閱讀 294評論 0 0
  • 導(dǎo)讀 為了避免歧義,文檔大量使用了「能愿動詞」尘奏,對應(yīng)的解釋如下:必須(Must) - 只能這樣子做滩褥,請無條件遵循,...
    PENG先森_曉宇閱讀 559評論 0 4
  • 就像代碼需要代碼規(guī)范一樣炫加,代碼管理同樣需要一個清晰的流程和規(guī)范 Git 常用的分支 Production分支也就是...
    馮正_566c閱讀 195評論 0 0
  • 全文兩個注意點: 在做每一個git操作前都應(yīng)該先pull代碼 pom文件里的版本號變更后都要記得去刷菜單(現(xiàn)有邏輯...
    乖乖果效36閱讀 4,791評論 3 85