git工作流及commit規(guī)范


Git 是目前最流行的源代碼管理工具致份”涑椋可以方便的維護(hù)和管理團(tuán)隊(duì)合作項(xiàng)目。

但若沒有一個(gè)合理氮块,規(guī)范的分支命名和管理绍载,以及commit消息的編寫,會(huì)使得倉庫越來越臃腫滔蝉,也難以看懂歷史變更击儡,版本發(fā)布,bug修改等蝠引。

上周自己向主項(xiàng)目倉庫提交了一個(gè)pull request阳谍,說句實(shí)在話,commit消息雜亂無章螃概,重復(fù)commit矫夯,而且還混帶了其他人的commit消息等等,真的干擾到主項(xiàng)目的管理和維護(hù)吊洼。

鑒于此训貌,LZ查閱了一些網(wǎng)上的資料,以及自己親手實(shí)踐測試冒窍,寫下這篇文章递沪,來規(guī)范自己以后的git工作流程,如果萬幸的話超燃,還能給其他開發(fā)者一些參考区拳。

這里先給大家安利一篇好文 Git 分支管理最佳實(shí)踐,LZ也主要參考了該文章意乓。

基于git flow的項(xiàng)目流程

文字?jǐn)⑹隹赡苡悬c(diǎn)啰嗦樱调,直接上圖比較直觀

點(diǎn)擊看大圖
流程圖詳解

說明:
upstream : 遠(yuǎn)程主項(xiàng)目倉庫
origin : 遠(yuǎn)程個(gè)人倉庫
local : 本地倉庫
倉庫指向的白色框,代表該倉庫下的分支

  • 關(guān)系建立
    1届良、fork主項(xiàng)目到個(gè)人的遠(yuǎn)程倉庫
    2笆凌、將fork下來的項(xiàng)目clone到本地
    3、git remote add upstream 建立與主項(xiàng)目遠(yuǎn)程倉庫的關(guān)聯(lián)
  • 開發(fā)某功能xxx
    4士葫、項(xiàng)目管理者在主項(xiàng)目倉庫新建分支 feature/xxx
    5乞而、將新分支同步到本地dev
    6、git checkout -b feature/xxx 建立本地對(duì)應(yīng)功能分支
    (此時(shí)本地的dev和feature/xxx分支與upstream上的分別對(duì)應(yīng)相等)
    新功能開發(fā)完成后慢显,測試通過后
    7爪模、push到遠(yuǎn)程倉庫
    8欠啤、提交pull request
    9、合并該分支并刪除

commit提交規(guī)范

關(guān)于commit信息屋灌,它并沒有固定的格式洁段,但是每次的commit信息應(yīng)當(dāng)是簡潔明了的表達(dá)你的修改,讓其他合作者很容易的看懂共郭。

就目前來看祠丝,最受歡迎,使用最廣泛的就是 Angular規(guī)范除嘹,如下圖

Angular.js

在Angular規(guī)范中写半,將commit message規(guī)定了三部分,分別是

  • Header
  • Body
  • Footer

在你的commit信息中尉咕,Header是必須的叠蝇,而后面兩種可加可不加,LZ個(gè)人認(rèn)為只需Header即可龙考,簡潔明了蟆肆,commit太復(fù)雜了反而不好矾睦。所以這里只介紹一下Header部分怎么寫晦款,其余兩部分可以移步 Angular規(guī)范 看官方詳細(xì)的說明。你也可以參考Angular.js開源項(xiàng)目的commit

Header

Header只需一行枚冗,包括type缓溅,scope,subject赁温,格式如下

type(scope): subject

1坛怪、type(必選)
type 用于說明你commit的類型,有如下7種

  • feat:新功能 (feature)
  • fix:bug修復(fù)(bug fix)
  • docs:文檔相關(guān) (documentation)
  • style:代碼格式 (formatting, missing semi colons, …)
  • refactor:重構(gòu)
  • test:添加測試(when adding missing tests)
  • chore:工具或維護(hù)變動(dòng) (maintain)

2股囊、scope(可選袜匿,建議選擇)
scope用于表明你此次提交改動(dòng)的范圍和地方。當(dāng)你找不到合適的詞表明此次改動(dòng)時(shí)稚疹,可以填上*

3居灯、subject(必選)
簡短的文本來描述你的改動(dòng)

  • 動(dòng)詞開頭,第一人稱内狗,如change怪嫌,不要寫changed或者changes
  • 第一個(gè)字母不要大寫
  • 不要以句號(hào)( . )結(jié)尾

備注:如果某次commit是為了fix某個(gè)issue,那么要在Footer部分加上

Close #123

或者關(guān)閉多個(gè)

Closes #123柳沙,#456
Revert

是專門用來撤銷上一次commit的操作岩灭,格式如下

revert: <被撤銷的commit的Header部分>
This reverts commit <被撤銷commit的SHA標(biāo)識(shí)符(git log查看)>
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市赂鲤,隨后出現(xiàn)的幾起案子噪径,更是在濱河造成了極大的恐慌柱恤,老刑警劉巖,帶你破解...
    沈念sama閱讀 212,599評(píng)論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件找爱,死亡現(xiàn)場離奇詭異膨更,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)缴允,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,629評(píng)論 3 385
  • 文/潘曉璐 我一進(jìn)店門荚守,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人练般,你說我怎么就攤上這事矗漾。” “怎么了薄料?”我有些...
    開封第一講書人閱讀 158,084評(píng)論 0 348
  • 文/不壞的土叔 我叫張陵敞贡,是天一觀的道長。 經(jīng)常有香客問我摄职,道長誊役,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 56,708評(píng)論 1 284
  • 正文 為了忘掉前任谷市,我火速辦了婚禮蛔垢,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘迫悠。我一直安慰自己鹏漆,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 65,813評(píng)論 6 386
  • 文/花漫 我一把揭開白布创泄。 她就那樣靜靜地躺著艺玲,像睡著了一般。 火紅的嫁衣襯著肌膚如雪鞠抑。 梳的紋絲不亂的頭發(fā)上饭聚,一...
    開封第一講書人閱讀 50,021評(píng)論 1 291
  • 那天,我揣著相機(jī)與錄音搁拙,去河邊找鬼秒梳。 笑死,一個(gè)胖子當(dāng)著我的面吹牛感混,可吹牛的內(nèi)容都是我干的端幼。 我是一名探鬼主播,決...
    沈念sama閱讀 39,120評(píng)論 3 410
  • 文/蒼蘭香墨 我猛地睜開眼弧满,長吁一口氣:“原來是場噩夢啊……” “哼婆跑!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起庭呜,我...
    開封第一講書人閱讀 37,866評(píng)論 0 268
  • 序言:老撾萬榮一對(duì)情侶失蹤滑进,失蹤者是張志新(化名)和其女友劉穎犀忱,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體扶关,經(jīng)...
    沈念sama閱讀 44,308評(píng)論 1 303
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡阴汇,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,633評(píng)論 2 327
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了节槐。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片搀庶。...
    茶點(diǎn)故事閱讀 38,768評(píng)論 1 341
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖铜异,靈堂內(nèi)的尸體忽然破棺而出哥倔,到底是詐尸還是另有隱情,我是刑警寧澤揍庄,帶...
    沈念sama閱讀 34,461評(píng)論 4 333
  • 正文 年R本政府宣布咆蒿,位于F島的核電站,受9級(jí)特大地震影響蚂子,放射性物質(zhì)發(fā)生泄漏沃测。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 40,094評(píng)論 3 317
  • 文/蒙蒙 一食茎、第九天 我趴在偏房一處隱蔽的房頂上張望蒂破。 院中可真熱鬧,春花似錦董瞻、人聲如沸寞蚌。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,850評(píng)論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至壹哺,卻和暖如春抄伍,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背管宵。 一陣腳步聲響...
    開封第一講書人閱讀 32,082評(píng)論 1 267
  • 我被黑心中介騙來泰國打工截珍, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人箩朴。 一個(gè)月前我還...
    沈念sama閱讀 46,571評(píng)論 2 362
  • 正文 我出身青樓岗喉,卻偏偏與公主長得像,于是被迫代替她去往敵國和親炸庞。 傳聞我的和親對(duì)象是個(gè)殘疾皇子钱床,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 43,666評(píng)論 2 350

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