Pull request 团队合作开发使用详解

今天和大家介绍一种团队开发中代码提交中使用的方法,主要是使用git命令和hg命令进行代码提交的方法,我们使用比较多的是github.comgitee.combitbucket.com这几种代码管理系统。我介绍的方法在这几个系统中都可以使用,只是有个别细节需要注意,我会在介绍的过程中提出来的。首先来看一张我画的示意图。

Pull request示意图

应用场景

我们有一个项目叫project,存在公司的主仓库中,现在我们有多个人对这个项目做协作开发,project项目中有两个分支online(线上分支)和test(测试分支),online分支是需要部署到生产环境的,test分支是用于测试环境的,我们的上线流程是,代码一定要经过测试通过后才能上线。对于一个新的需求做开发,我们可能对这个项目做一个或多个功能的开发,每个人分到一个或多个功能做开发,这个过程中需要注意,如何做到多人开发,代码同步,如何进行测试,如何解决代码冲突,还有就是如何做code review等等,针对以上的问题,我们做以下的操作步骤。

操作步骤

1、在公司的主仓库中存在project项目,项目中含有online分支和test分支
2、首先Fork主仓库中的project项目到自己的仓库中。如何Fork请自行查找。
3、从自己的仓库中clone项目到本地仓库,查看本地仓库是否含有online分支和test分支
4、修改git命令或是hg命令的配置文件,建立与本地仓库与主仓库的联系

git命令:修改git的cong文件(.git/config)增加如下内容

 [remote "main"]                # main 为主仓库的名字,这个随便起,看自己的习惯
    url = "替换为主仓库的clone地址"
    fetch = +refs/heads/*:refs/remotes/origin/*

hg命令:修改hg的cong文件(.hg/hgrc)增加如下内容

[paths]
    default = "默认的"         # 这个不需要修改,也不要删除,一定要保留
    main = "主仓库的clone地址"

5、以上就建立完了本地仓库与主仓库和自己的仓库的联系,接下来我详解一下一个新功能(如用户列表)的开发流程
6、首先进入项目目录,切换到online分支,并拉取主仓库online分支的最新代码到本地仓库,与本地仓库的online分支合并。操作如下
git命令

$ git checkout online
$ git pull main online

hg命令

$ hg up online
$ hg pull main
$ hg up

7、基于当前的online分支创建一个功能分支,分支的名字最好和功能有关系,最好加上一个前缀,表明身份,如我的花名叫白起,我创建一个用户列表的功能分支为:bai_user_list.

关于创建分支,这里就要多说一点了,为什么要这样创建分支
(1)、因为我们所有开发的功能最终都要上线的,所以一定要基于online建分支,建分支前先把最新的online分支代码拉取下来并合并
(2)、建立分支一定要与功能有关系,尽量以功能为名称,因为有时开发的功能多了,就忘了哪个分支对应哪个功能了
(3)、为什么要加前缀,这个是因为多人开发的过程中可能有很多相同的功能开发,这样就能区分相同功能都有谁来开发了,还有在切换分支的时候只要输入前缀,然后使用双tab键就能列出所有以这个前缀开头的分支,也就知道自己开发了哪些分支了
(4)、因为以hg(mercurial)管理的代码系统,里面只有一个主分支,其他的分支都是在主分支上建立的节点,pull永远都是对所有分支做拉取、push永远是对本地的所有分子做提交。这样在主仓库那里查看分支的话就会有好多分支,查找和管理起来比较混乱。而git管理的代码系统的每个分支都是相对独立的,pull可以拉取指定的分支,push也是提交指定的分支,这样主仓库永远只有online和test分支。其实我们开发的功能分支只要合并到online上就没有保留的必要了。所以也需要删除,git能做到删除分支,但是hg却做不到删除分支,只能关闭分支

git命令

$ git checkout online
$ git checkout -b bai_user_list

hg命令

$ hg up online
$ hg branch bai_user_list
$ hg ci -m "创建用户列表功能分支"    # 这里一定要做一次提交,如果不做提交,修改完切换分支,会把内容丢失,切记!!

8、我们到bai_user_list分支上就可以开始我们的开发工作了,在这个分支上我们可以做多次提交,这里的提交不会影响到其他分支,等我们开发完了进入下一步提交测试
9、开发完成提交测试,需要把bai_user_list合并到test分支,首先切换到test分支,并拉取最新的代码,然后再merge分支

git命令

$ git checkout test
$ git pull main test                  # 这个拉取主仓库test分支的代码到本地,并与本地代码合并
$ git merge bai_user_list --squash    # 这个--squash参数很重要,它把bai_user_list分支中的多次提交合并成一次提交,合并到test分支上
$ git status                          # 这个地方也许有冲突,那么就解决冲突
$ git commit -am "测试"               # 一定要做commit提交
$ git push                            # 这个就提交到了自己仓库中的test分支上了

hg命令

$ hg update test
$ hg pull main               # 这个拉取主仓库的代码到本地
$ hg up                      # 合并远程仓库的代码
$ hg merge bai_user_list     # 合并分支
$ hg st                      # 查看是否有冲突,并解决冲突
$ hg ci -m "测试"            # 一定要做commit提交
$ hg push                    # 这个就提交到了自己仓库中的test分支上了

10、提交到自己的仓库之后就需要创建pull request,一定是自己仓库中test分支到主仓库test分支的pull requestpull request的操作就不详细说了自行查找一下就行了,很简单的操作。
11、提交完pull request之后,需要有一个有管理权限的人把此次pull request合并到主仓库上,这个地方可以进行code review,如果发现代码有问题,可以不做合并,通知开发人员修改,之后再提交。审核通过后就可以合并代码了,合并之后就可以就行代码测试了。
12、测试的过程中可能有很多bug,需要反复修改这样只需要重复8、9步骤,直到通过测试。
13、测试通过之后需要上线,我们只需要依据第9步,把分支换成online就行了,操作不知如下:

git命令

$ git checkout online
$ git pull main online                # 这个拉取主仓库online分支的代码到本地,并与本地代码合并
$ git merge bai_user_list --squash    # 这个--squash参数很重要,它把bai_user_list分支中的多次提交合并成一次提交,合并到online分支上
$ git status                          # 这个地方也许有冲突,那么就解决冲突
$ git commit -am "上线"               # 一定要做commit提交
$ git push                            # 这个就提交到了自己仓库中的online分支上了

hg命令

$ hg update online
$ hg pull main               # 这个拉取主仓库的代码到本地
$ hg up                      # 合并远程仓库的代码
$ hg merge bai_user_list     # 合并分支
$ hg st                      # 查看是否有冲突,并解决冲突
$ hg ci -m "上线"            # 一定要做commit提交
$ hg push                    # 这个就提交到了自己仓库中的online分支上了

14、提交到online分支之后就可以发送pull request操作了,创建自己仓库中的online分支到主仓库的online的pull request,然后通知管理员合并分支并上线
15、上线完成之后我们本地创建的功能分支bai_user_list分支需要删除。一定要删除,表明这个功能已经开发完成。
git命令

$ git checkout online
$ git branch -d bai_user_list      # 删除本地分支

hg命令

$ hg update bai_user_list
$ hg ci -m "上线" --close           # hg不能删除分支,只能关闭分支

以上就是团队开发的详细流程,整个过程都能用上面的图来说明,绿色的箭头我们只进行一次操作,红色的箭头是我们经常进行的操作,希望大家熟练掌握,减少在开发中因为提交代码带来的麻烦。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Git 命令行学习笔记 Git 基础 基本原理 客户端并不是只提取最新版本的文件快照,而是把代码仓库完整的镜像下来...
    sunnyghx阅读 3,958评论 0 11
  • Git 基础 基本原理 客户端并不是只提取最新版本的文件快照,而是把代码仓库完整的镜像下来。这样一来,任何一处协同...
    __silhouette阅读 15,958评论 5 147
  • 海信博纳SMART智能冰箱 核心提示: 海信博纳SMART智能冰箱,搭载物联云服务,引入全新的食品管理功能,为您及...
    爱林汀阅读 1,005评论 0 0
  • 你会发现自己并不孤独,这个世界上有比你更早感受痛苦的人,而且他们把这些感受切实描述了出来,在那些文字中自己去感受去...
    _一木阅读 4,781评论 0 5
  • “如讲到“有朋自远方来,不亦乐乎”,徒儿们以为远道来了朋友,孔子高兴,而老汪说高兴个啥呀,恰恰是圣人伤了心,如果身...
    嗷呜大王是也阅读 281评论 0 2