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

fishfish-yu · 2019年12月10日 · 最后由 fishfish-yu 回复于 2019年12月10日 · 2464 次阅读

注：我们的 Airtest 官方公众号（AirtestProject）会持续更新大家对于 Airtest 感兴趣的问题，欢迎有需要的同学关注并查看我们更多的内容。
如想向我们反馈关于 AirtestProject 想了解的问题，欢迎到公众号后台留言。

前言

上期在 “如何拉取远程仓库的分支到本地测试” 的帖子里，我们向大家介绍了如何在本地安装并使用Airtest在 Github 上面的源码。这期我们来讲一下剩余那部分的内容：“如何上传本地的修改到Airtest仓库上给其他用户使用”，即如何给开源项目贡献代码。

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

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

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

下文是具体的操作方法。

给开源项目贡献代码

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

首先我们需要打开这个开源项目的url：https://github.com/AirtestProject/Airtest ；然后点击右上角的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代码，还需要同步主仓库上的更新；因为这部分的内容比较复杂，所以我们需要先来理解一些概念：

在对子仓库修改的过程中，如果主仓库进行了修改更新，子仓库是不知道且不会同步的
在主仓库进行了修改更新的情况下，如果子仓库没有同步这部分改动而坚持向主仓库发起pull request，很可能会被主仓库的管理员拒绝
origin是用来向子仓库提交更新的远程仓库，Git 会默认把origin与你的子仓库关联在一起，可以通过git remote -vv查看

用来同步主仓库更新的远程仓库，则需要我们手动进行添加，可以将其命名为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项目下，有一个项目支持设备列表的文档 https://github.com/AirtestProject/Airtest/blob/master/docs/wiki/platforms.md ，但是因为设备很多，我们更新不过来，所以有一些热心的用户，就会在自己本地fork的项目上面修改了这个platforms.md文档，然后再向我们发起一个pull request：