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)啰嗦樱调,直接上圖比較直觀
流程圖詳解
說明:
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規(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查看)>