向开源项目贡献代码那点事

简介: 向开源项目贡献代码那点事

前言



上期在“详解 | 在本地安装使用GitHub上的开源项目”的文章里,我们向大家介绍了如何在本地安装并使用Airtest在Github上面的源码。这期我们来讲一下剩余那部分的内容:“如何上传本地的修改到Airtest仓库上给其他用户使用”,即如何给开源项目贡献代码


需要注意的是,clone操作是不需要项目权限的,只要你注册了GitHub账号,就可以把开源的项目clone下来,就像上期教程我们所演示的那样,可以直接从开源项目那里把项目clone下来。


但是如果你想要贡献代码,即把你本地的代码上传到项目的远程仓库的话,一般都是不能直接传的,因为大部分人都不是项目的开发者,没有直接push代码的权限,所以贡献代码的流程大致如下:


  1. fork原始项目到自己的账号下
  2. 克隆fork到的项目到本地进行修改
  3. 提交修改并同步原始项目仓库的更新
  4. push代码到自己账号的项目仓库里
  5. 向原始项目发起提交申请
  6. 原始项目的管理员同意后,才会merge到原始项目的仓库里


下文是具体的操作方法。


给开源项目贡献代码



fork开源项目到自己的账户上


首先我们需要打开这个开源项目的urlgithub.com/AirtestProj… ;然后点击右上角的Fork按钮。



等待一段时间后,开源项目AirtestProject/Airtest就被复制到我们自己的仓库里面了,命名为你的用户名/Airtest



这个 Fork 后的项目是我们自己账户上的项目,所以我们可以随意修改,且并不会影响到真正的AirtestProject/Airtest项目的。下面我们把它称之为子仓库。原始项目的那个仓库,在下文我们称之为主仓库。


clone子仓库到本地


在本地目录下,右键Git Bush Here,输入以下命令把自己账户上fork得到的仓库(子仓库)clone到本地:


# Clone 到本地的项目目录
git clone https://github.com/your-user-name/Airtest Airtest 
复制代码



切换到某个分支


进入刚才clone好的Airtest目录,右键Git Bush Here,默认进去的是master分支。如果我们是在别的分支上做了改动,比如aaa分支,就可以输入以下命令切换到aaa分支:


# 创建并切换到 aaa 分支
git checkout -b aaa 
复制代码



提交修改到本地仓库


想要提交本地aaa分支上的修改,我们可以使用以下命令将提交修改到本地仓库上:


# 添加修改过的文件
git add 文件名
# 提交commit
git commit -m "改动的描述"
# 可以使用下述命令添加所有文件
git add -A 
复制代码


同步主仓库的更新


提交commit之后,我们并不能马上push代码,还需要同步主仓库上的更新;因为这部分的内容比较复杂,所以我们需要先来理解一些概念:


  1. 在对子仓库修改的过程中,如果主仓库进行了修改更新,子仓库是不知道且不会同步的
  2. 在主仓库进行了修改更新的情况下,如果子仓库没有同步这部分改动而坚持向主仓库发起pull request,很可能会被主仓库的管理员拒绝
  3. origin是用来向子仓库提交更新的远程仓库,Git会默认把origin与你的子仓库关联在一起,可以通过git remote -vv查看
  4. 用来同步主仓库更新的远程仓库,则需要我们手动进行添加,可以将其命名为upstream或是其它你喜欢的名字,还可以通过git remote -v查看仓库之间的关联


了解了上述的概念之后,我们假设已经手动添加了upstream,并且upstream已经更新了很多提交,我们就可以用以下的方式拉取并合并upstream上的更新:


# ①切换到 master 分支
git checkout master 
# ②使用 rebase 模式拉取 upstream/master 上的更新,然后与本地的master合并
git pull --rebase upstream master:master
# ③切换到 aaa 分支
git checkout aaa 
# ④使用 rebase 模式合并本地的 aaa 和 master 分支
git rebase master 
复制代码


或者我们还可以使用下面这种方式拉取合并upstream的更新:


# ①切换到 master 分支
git checkout master 
# ②获取 upstream 上的 master 分支
git fetch upstream master 
# ③切换到 aaa 分支
git checkout aaa  
# ④使用 rebase 模式合并本地的 aaa 和 upstream/master 分支
git rebase upstream/master 
复制代码


将修改的代码push到子仓库上


完成了上述的更新合并以后,我们才可以把代码push到子仓库上:


# 将本地 aaa 分支的代码 push 到 origin 的 aaa 分支
git push origin aaa 
复制代码


向主仓库发起pull request


push代码以后,会跳出GitHub网站的登录弹窗,登陆后会智能识别并弹出按钮 Compare & pull request,点击后填写一些信息即可向主仓库发起pull request


需要注意的是,主仓库的开发人员收到你的申请以后,他们还会对你的改动进行审核(即像上一篇推文讲述的那样,把你的代码拉取到本地测试一下),只有审核通过才会真正被merge到主仓库上。


举个例子,在我们Airtest项目下,有一个项目支持设备列表的文档 github.com/AirtestProj… ,但是因为设备很多,我们更新不过来,所以有一些热心的用户,就会在自己本地fork的项目上面修改了这个platforms.md文档,然后再向我们发起一个pull request



项目的管理员收到这个pull request之后,就会查看用户修改了什么地方:



如果这个用户的pull request没有问题,Airtest的项目管理员就会 merge 这个pull request到主仓库上。至此,该用户就可以成为github上面3k star项目的contributor啦!

相关文章
|
算法
如何更有效地学习开源项目的代码?
盛大创新研究院研究员 庄表伟:学习开源 尽可能在代码里找答案 庄表伟提供了以下9个建议: 1.在下载源代码之后,首先要跑起来,编译通过、正常运行; 2.在你觉得最有可能运行到的地方,设置断点或者抛出异常,这样,就能够找到一个项目在正常运行时的入口点; 3.从入口点所在的那个源文件开始阅读,逐步把握整个项目是如何启动起来; 4.随便改点代码,看看会不会报错,如果报错,会从哪里报错; 5.试着把报错屏蔽、修复、或者绕开; 6.尝试理解一个系统的内部结构,多少组成部分,主线模块是哪些?辅助模块是哪些? 7.从实际需要出发,修改这个项目,满足自己的某一个小的需求。
806 0
|
测试技术 开发工具 git
【手把手指导】给开源项目贡献代码
很多新人学习了技术,但是没有地方施展。
427 0
【手把手指导】给开源项目贡献代码
|
开发工具 git C#
如何为 smartraiden 贡献代码
如何为 smartRaiden 贡献代码 1.Fork 项目 登录 github 账号,并访问https://github.com/SmartMeshFoundation/SmartRaiden,然后点击右上角的 fork 按钮,等待几秒钟以后就可以在你自己的 github 账号下看到 smartraiden.
1211 0
|
Android开发 iOS开发 开发者
初学者指南:为开源做贡献
当我刚开始做Rails开发者时,我认为所有的Rails gems都是魔法。一些聪明人正在制作这些牛逼的类库让我使用!我不知道这些类库有多少可以使用,我认为它们是好的。它们运行着,并做了我需要它们做的工作。它们好像如此深奥、被想出来,以致于我甚至不知道该如何为它们贡献力量,即使我想!
158 0
初学者指南:为开源做贡献
|
消息中间件 存储 设计模式
聊聊如何学习开源项目
工作几年的程序员同学,有了一定的项目经验,对于编程也有了自己的理解,但他们偶尔也会感到困惑,不知道接下来该如何提升自己。 在笔者看来:"这个阶段的程序员最需要的是提升自身编程能力和视野高度,而学习开源项目是最有效的方法之一"。
聊聊如何学习开源项目
|
Cloud Native Go 开发者
如何为开源项目做出贡献?
如何为开源项目做出贡献?
137 0

热门文章

最新文章