参与Github开源项目

1,367 阅读3分钟

开源就是开放源码,毕竟「源码面前,了无秘密」。开源,更重要的意义在于,围绕产品的社区发展,可以将众人的力量回馈给开源产品。众人的参与,提出意见、想法与贡献等这个良性的循环机制,「人人为我,我为人人」。

第一步:fork

首先在 Github上找到要参与的项目,点击右上方的 「Fork」。此时,你会看到像我们常使用的扫描仪一样,当前项目的「高清扫描版」不久就会出现在你的repo中。不久, Fork 成功后,这个项目会显示在你个人的 Repository 中。同时显示从哪Fork出来的。可以方便的进行源的跟踪。Fork 之后,根据使用的情况,可以对其中你认为需要改进的地方提交代码,参与项目。

第二步:修改代码提交

记住,现在的这个项目,是「」的项目。位于你的Repo中。所有的 git 操作,需要先以此这基准,git clone 到本地,进行操作,然后再commit 到「你」的仓库中。所有的修改,变更都已经提交到 git ,同时 push 到远程分支时,你的这些修改的代码在 Github上你的仓库里也就都能看到了。

第三步: 创建 Pull request

此时,在你仓库中点击「Pull Request」,会显示对于「你这个项目」,别人发起的 Pull Request。我们现在是想向「源仓库」提交代码,所以再点击右上方绿色的「New pull request」按钮。

此时,可以选择要将「你的仓库」哪个分支,提交到「源仓库」的哪个分支上。此时会显示变更的文件内容,提交人等。点击绿色的「Create pull request」按钮,输入信息,完成创建 PR。

到此为止,「源仓库」的 Pull request 列表中,会显示我们刚刚发起的PR,状态是 Open,刚开始会进行一次「代码检查」与「持续集成」。

等待上述「代码检查」与「持续集成」完成,没有问题时,图标会变成绿色。此时,「源仓库」的维护人,Commiter,就可以将你提交的内容合并到源分支中。

但是一般来说,需要我们描述本次提交变更的内容,主要实现什么功能,可以同时再提交一些截图之类的。

第四步(Optional): 增加描述等更详细的信息

然后我们根据要求,再在PR中增加详细描述,截图等内容,再次等待 review。

等待 Commiter review 没问题之后,会将本次内容,合并到源仓库的指定分支中,此时PR中会显示xxx merge commit 到什么分支,同时PR的状态是「Closed」。此时,本次参与已经完成。

总结下,参与一个开源项目的过程:

  1. fork 一个项目

  2. 提交修改与变更

  3. 向源库发起 Pull Request

  4. 等待 Code Review,如果需要,再补充详细的内容

  5. 等待代码合并到源库

  6. 完成提交