git管理规范.docx
- 文档编号:6216978
- 上传时间:2023-01-04
- 格式:DOCX
- 页数:12
- 大小:213.10KB
git管理规范.docx
《git管理规范.docx》由会员分享,可在线阅读,更多相关《git管理规范.docx(12页珍藏版)》请在冰豆网上搜索。
git管理规范
Git使用规范流程以及支管理策略
团队开发中,遵循一个合理、清晰的Git使用流程,是非常重要的。
否则,每个人都提交一堆杂乱无章的commit,项目很快就会变得难以协调和维护。
下面是ThoughtBot的Git使用规范流程。
我从中学到了很多,推荐你也这样使用Git。
第一步:
新建分支
首先,每次开发新功能,都应该新建一个单独的分支(这方面可以参考《Git分支管理策略》)。
#获取主干最新代码
$gitcheckoutmaster
$gitpull
#新建一个开发分支myfeature
$gitcheckout-bmyfeature
第二步:
提交分支commit
分支修改后,就可以提交commit了。
$gitadd--all
$gitstatus
$gitcommit--verbose
gitadd命令的all参数,表示保存所有变化(包括新建、修改和删除)。
从Git2.0开始,all是gitadd的默认参数,所以也可以用gitadd.代替。
gitstatus命令,用来查看发生变动的文件。
gitcommit命令的verbose参数,会列出diff的结果。
第三步:
撰写提交信息
提交commit时,必须给出完整扼要的提交信息,下面是一个范本。
Present-tensesummaryunder50characters
*Moreinformationaboutcommit(under72characters).
*Moreinformationaboutcommit(under72characters).
http:
//project.management-
第一行是不超过50个字的提要,然后空一行,罗列出改动原因、主要变动、以及需要注意的问题。
最后,提供对应的网址(比如Bugticket)。
第四步:
与主干同步
分支的开发过程中,要经常与主干保持同步。
$gitfetchorigin
$gitrebaseorigin/master
第五步:
合并commit
分支开发完成后,很可能有一堆commit,但是合并到主干的时候,往往希望只有一个(或最多两三个)commit,这样不仅清晰,也容易管理。
那么,怎样才能将多个commit合并呢?
这就要用到gitrebase命令。
$gitrebase-iorigin/master
gitrebase命令的i参数表示互动(interactive),这时git会打开一个互动界面,进行下一步操作。
下面采用TuteCosta的例子,来解释怎么合并commit。
pick07c5abdIntroduceOpenPGPandteachbasicusage
pickde9b1ebFixPostChecker:
:
Post#urls
pick3e7ee36Heykids,stopallthehighlighting
pickfa20af3gitinteractiverebase,squash,amend
#Rebase8db7e8b..fa20af3onto8db7e8b
#
#Commands:
#p,pick=usecommit
#r,reword=usecommit,buteditthecommitmessage
#e,edit=usecommit,butstopforamending
#s,squash=usecommit,butmeldintopreviouscommit
#f,fixup=like"squash",butdiscardthiscommit'slogmessage
#x,exec=runcommand(therestoftheline)usingshell
#
#Theselinescanbere-ordered;theyareexecutedfromtoptobottom.
#
#IfyouremovealinehereTHATCOMMITWILLBELOST.
#
#However,ifyouremoveeverything,therebasewillbeaborted.
#
#Notethatemptycommitsarecommentedout
上面的互动界面,先列出当前分支最新的4个commit(越下面越新)。
每个commit前面有一个操作命令,默认是pick,表示该行commit被选中,要进行rebase操作。
4个commit的下面是一大堆注释,列出可以使用的命令。
∙pick:
正常选中
∙reword:
选中,并且修改提交信息;
∙edit:
选中,rebase时会暂停,允许你修改这个commit(参考这里)
∙squash:
选中,会将当前commit与上一个commit合并
∙fixup:
与squash相同,但不会保存当前commit的提交信息
∙exec:
执行其他shell命令
上面这6个命令当中,squash和fixup可以用来合并commit。
先把需要合并的commit前面的动词,改成squash(或者s)。
pick07c5abdIntroduceOpenPGPandteachbasicusage
sde9b1ebFixPostChecker:
:
Post#urls
s3e7ee36Heykids,stopallthehighlighting
pickfa20af3gitinteractiverebase,squash,amend
这样一改,执行后,当前分支只会剩下两个commit。
第二行和第三行的commit,都会合并到第一行的commit。
提交信息会同时包含,这三个commit的提交信息。
#Thisisacombinationof3commits.
#Thefirstcommit'smessageis:
IntroduceOpenPGPandteachbasicusage
#Thisisthe2ndcommitmessage:
FixPostChecker:
:
Post#urls
#Thisisthe3rdcommitmessage:
Heykids,stopallthehighlighting
如果将第三行的squash命令改成fixup命令。
pick07c5abdIntroduceOpenPGPandteachbasicusage
sde9b1ebFixPostChecker:
:
Post#urls
f3e7ee36Heykids,stopallthehighlighting
pickfa20af3gitinteractiverebase,squash,amend
运行结果相同,还是会生成两个commit,第二行和第三行的commit,都合并到第一行的commit。
但是,新的提交信息里面,第三行commit的提交信息,会被注释掉。
#Thisisacombinationof3commits.
#Thefirstcommit'smessageis:
IntroduceOpenPGPandteachbasicusage
#Thisisthe2ndcommitmessage:
FixPostChecker:
:
Post#urls
#Thisisthe3rdcommitmessage:
#Heykids,stopallthehighlighting
squash和fixup命令,还可以当作命令行参数使用,自动合并commit。
$gitcommit--fixup
$gitrebase-i--autosquash
这个用法请参考这篇文章,这里就不解释了。
第六步:
推送到远程仓库
合并commit后,就可以推送当前分支到远程仓库了。
$gitpush--forceoriginmyfeature
gitpush命令要加上force参数,因为rebase以后,分支历史改变了,跟远程分支不一定兼容,有可能要强行推送(参见这里)。
第七步:
发出PullRequest
提交到远程仓库以后,就可以发出PullRequest到master分支,然后请求别人进行代码review,确认可以合并到master。
如果你严肃对待编程,就必定会使用”版本管理系统”(VersionControlSystem)。
眼下最流行的”版本管理系统”,非Git莫属。
相比同类软件,Git有很多优点。
其中很显著的一点,就是版本的分支(branch)和合并(merge)十分方便。
有些传统的版本管理软件,分支操作实际上会生成一份现有代码的物理拷贝,而Git只生成一个指向当前版本(又称”快照”)的指针,因此非常快捷易用。
但是,太方便了也会产生副作用。
如果你不加注意,很可能会留下一个枝节蔓生、四处开放的版本库,到处都是分支,完全看不出主干发展的脉络。
VincentDriessen提出了一个分支管理的策略(中文简译版),我觉得非常值得借鉴。
它可以使得版本库的演进保持简洁,主干清晰,各个分支各司其职、井井有条。
理论上,这些策略对所有的版本管理系统都适用,Git只是用来举例而已。
如果你不熟悉Git,跳过举例部分就可以了。
一、主分支Master
首先,代码库应该有一个、且仅有一个主分支。
所有提供给用户使用的正式版本,都在这个主分支上发布。
Git主分支的名字,默认叫做Master。
它是自动建立的,版本库初始化以后,默认就是在主分支在进行开发。
二、开发分支Develop
主分支只用来分布重大版本,日常开发应该在另一条分支上完成。
我们把开发用的分支,叫做Develop。
这个分支可以用来生成代码的最新隔夜版本(nightly)。
如果想正式对外发布,就在Master分支上,对Develop分支进行”合并”(merge)。
Git创建Develop分支的命令:
gitcheckout-bdevelopmaster
将Develop分支发布到Master分支的命令:
#切换到Master分支
gitcheckoutmaster
#对Develop分支进行合并
gitmerge–no–ffdevelop
这里稍微解释一下,上一条命令的–no–ff参数是什么意思。
默认情况下,Git执行”快进式合并”(fast-farwardmerge),会直接将Master分支指向Develop分支。
使用–no–ff参数后,会执行正常合并,在Master分支上生成一个新节点。
为了保证版本演进的清晰,我们希望采用这种做法。
关于合并的更多解释,请参考BenjaminSandofsky的《UnderstandingtheGitWorkflow》。
三、临时性分支
前面讲到版本库的两条主要分支:
Master和Develop。
前者用于正式发布,后者用于日常开发。
其实,常设分支只需要这两条就够了,不需要其他了。
但是,除了常设分支以外,还有一些临时性分支,用于应对一些特定目的的版本开发。
临时性分支主要有三种:
*功能(feature)分支
*预发布(release)分支
*修补bug(fixbug)分支
这三种分支都属于临时性需要,使用完以后,应该删除,使得代码库的常设分支始终只有Master和Develop。
四、功能分支
接下来,一个个来看这三种”临时性分支”。
第一种是功能分支,它是为了开发某种特定功能,从Develop分支上面分出来的。
开发完成后,要再并入Develop。
功能分支的名字,可以采用feature-*的形式命名。
创建一个功能分支:
gitcheckout-bfeature-xdevelop
开发完成后,将功能分支合并到develop分支:
gitcheckoutdevelop
gitmerge–no-fffeature-x
删除feature分支:
gitbranch-dfeature-x
五、预发布分支
第二种是预发布分支,它是指发布正式版本之前(即合并到Master分支之前),我们可能需要有一个预发布的版本进行测试。
预发布分支是从Develop分支上面分出来的,预发布结束以后,必须合并进Develop和Master分支。
它的命名,可以采用release-*的形式。
创建一个预发布分支:
gitcheckout-brelease-1.2develop
确认没有问题后,合并到master分支:
gitcheckoutmaster
gitmerge–no-ffrelease-1.2
#对合并生成的新节点,做一个标签
gittag-a1.2
再合并到develop分支:
gitcheckoutdevelop
gitmerge–no-ffrelease-1.2
最后,删除预发布分支:
gitbranch-drelease-1.2
六、修补bug分支
最后一种是修补bug分支。
软件正式发布以后,难免会出现bug。
这时就需要创建一个分支,进行bug修补。
修补bug分支是从Master分支上面分出来的。
修补结束以后,再合并进Master和Develop分支。
它的命名,可以采用fixbug-*的形式。
创建一个修补bug分支:
gitcheckout-bfixbug-0.1master
修补结束后,合并到master分支:
gitcheckoutmaster
gitmerge–no-fffixbug-0.1
gittag-a0.1.1
再合并到develop分支:
gitcheckoutdevelop
gitmerge–no-fffixbug-0.1
最后,删除”修补bug分支”:
gitbranch-dfixbug-0.1
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- git 管理 规范