文档章节

如何在开源项目中贡献代码

李韬_varyshare
 李韬_varyshare
发布于 2017/02/26 11:33
字数 1367
阅读 37
收藏 0

Github 是目前世界上最大的开源项目的托管交流平台。贡献开源项目的流程也是 Github 全力支持的,也一样是遵循 Github Flow,虽然跟前面团队合作流程会有一点差别。在团队内部,大家都是有写权限的。但是网上的开源项目参与者众多。如果你一上去就跟项目的拥有者说,Hey,你给我加个写权限吧,别逗了,人家也不认识你,怎么可能呢?

Fork

所以第一步是 Fork 这个项目。所谓我 fork 别人的一个项目,就是指做一个把这个项目做一个拷贝,放到我自己的账户下。

基于 fork 的整个的流程就是上图展示的思路。第一步,先 fork,这样我就有了 happypeter/TLCL 这个项目了,那既然是我自己的项目,我就可以把它 clone 到我本地,做修改,然后推送到 github 上的我自己的那个 fork 之中。这样我把我自己的 fork 跟上游的仓库,也就是 billie66 名下的仓库来进行对比,就可以发出 Pull Request 了。

下面来实际操作。

来到 TLCL 的项目主页,也就是 https://github.com/billie66/TLCL 。点右上角的 fork 按钮。

这样,我自己的名下就多了一个 TLCL 项目,这个项目就叫做原项目的一个 fork 。

到这里 fork 这一步就结束了。那对于 happypeter/TLCL 这个仓库,我当然有修改的权限了,可以在网页上修改直接发 PR。不过一般我会 clone 到本地客户端中,在本地作修改,点右下角的 Clone In Desktop 按钮,来把项目 clone 到本地。

做版本和同步

区别于团队合作的 Github Flow,这里主要是没有开新分支,而是创建了一个新的 fork。上游仓库 billie66/TLCL 中代码是在 gh-pages 分支上,那现在我在本地的 gh-pages 修改,新版本同步到在 happypeter/TLCL 的 gh-pages 上就可以了。

本地修改,做 commit,然后同步到远端的 happypeter/TLCL 中,这些步骤到现在应该是轻车熟路,小菜一碟了。于是到 github.com 可以看到下图的内容

如上图所示到 happypeter/TLCL 的仓库主页,可以看到最新的我做的版本的留言,点开就可以看到我这次修改的内容,现在可以来发 PR 了。

发 PR 和代码审核

发 PR 的过程跟前面介绍过的没有本质区别。

如上图,点一下项目页面右侧的 Pull Request 链接,到达的页面中会有一个大大的绿按钮 New Pull Request,点一下就看到下面的页面

注意上面1处,要选对是哪两个分支进行对比,左侧是上游分支,也就是“目的地”分支,右侧是我自己的分支,有修改的内容。有时候 github 能猜对拿哪两个分支做对比,有时候就要自己手动选择一下。分支要是选得不对那么2处对比出来的代码肯定也会有问题的,所以还是比较容易看出来的。下面就可以点3处的大按钮来发 PR 了。之后,在 billie66/TLCL 下面,注意不是 happypeter/TLCL 下面,就会看到这个 PR 。

当项目拥有者 billie66,或者是项目的协作者( collaborator ) 看到 Pull Request,就可以来跟我讨论。如果决定要把我的代码 merge 进自己的仓库,点一下 Merge Pull Request 按钮就可以了。

这样,我这次贡献代码的工作就结束了。TLCL 的版本历史中会永远留下 happypeter 的名字。同时我发的这个 PR 关掉之后,也可以在 billie66/TLCL 的 Pull Requests 一项下面被永久保存,所以我可以放心的删除我自己的那个 fork 了。

后续工作

删除一个 fork ,跟删除一个我自己的项目仓库是一样的。

如上图,点开 settings 然后进入 Danger Zone 找 Delete This Repository 就可以来删除 happypeter/TLCL。当然如果会频繁的贡献同一个项目,自己名下长期保留一个 fork 也是可以的,但是这时候就要保证这个 fork 和上游仓库的同步,也是挺麻烦的。所以对于初学者,删掉,过些日子如果又想贡献,再 fork 一次不迟。

对于项目维护者,如果想随时了解自己的项目都有哪些人正在自己的 fork 进行修改,可以看一下项目的Network,如下图:

基于 fork 的快速 PR

前面介绍过快速 PR了,不过那个流程是基于一个我自己有写权限的项目。那对于人家的开源项目,我根本就不能修改,能不用在网页上直接发开速 PR 呢?幸运的是,答案是肯定的。而且过程是超级的简单和直观。

做法就是,我来到 bille66/TLCL 的这个项目,不做 fork,而是直接打开一个我想要编辑的文件,修改,然后做 commit 的时候选择下图中的第二项。

这样,github 会自动帮我 fork 一个 happypeter/TLCL 出来,把我所做的改动 commit 到我自己的这个 fork 中。这之后,就直接进入发 PR 的界面,操作就和前面的过程一样了。

© 著作权归作者所有

共有 人打赏支持
李韬_varyshare

李韬_varyshare

粉丝 7
博文 27
码字总数 18582
作品 1
广州
个人站长
私信 提问
Linux基金会发布中文版企业开源指南

导读 Linux 基金会是一个通过开源实现大规模创新的非盈利性组织,已经发布了10本企业开源指南的中文翻译,旨在帮助高管,开源项目经理,开发人员,律师和决策者学习如何最佳利用开源。 CNCF...

问题终结者
2018/07/05
0
0
Linux 基金会和 TODO 联合发布中文版企业版开源指南

Linux 基金会是一个通过开源实现大规模创新的非盈利性组织,已经发布了10本企业开源指南的中文翻译,旨在帮助高管,开源项目经理,开发人员,律师和决策者学习如何最佳利用开源。 CNCF 首席技...

达尔文
2018/06/26
1K
2
Linux 基金会发布企业开源指南中文版

Linux 基金会发布了10本企业开源指南的中文版,旨在帮助高管,开源项目经理,开发人员,律师和决策者学习和了解开源, 介绍企业组织如何受益,以及如何正确实施。开源指南遵守共享授权CC4.0版...

marsdream
2018/06/27
0
0
【大牛之路】如何在github上为开源项目贡献

前言 我们在学习的日常中会用到的各种开源软件,大一点的Linux,Apache,Nginx,MySQL,Redis,小一点的Muduo,Axel,那么如何去给一个开源项目做贡献呢。 这里我主要介绍如何使用github来为...

XiyouLinux_Kangyijie
2017/11/22
0
0
如何为开源项目做出自己的贡献

我是开源软件的使用者,另一方面也是开源项目作者,所以想结合自己项目的实践来说说我对《如何为开源项目做出自己贡献》的一些理解。 1、单纯地使用开源软件,是不是对开源软件做出了贡献? ...

PSI
2016/05/06
1K
5

没有更多内容

加载失败,请刷新页面

加载更多

多表查询

第1章 多表关系实战 1.1 实战1:省和市  方案1:多张表,一对多  方案2:一张表,自关联一对多 1.2 实战2:用户和角色 (比如演员和扮演人物)  多对多关系 1.3 实战3:角色和权限 (比如...

stars永恒
40分钟前
1
0
求推广,德邦快递坑人!!!!

完全没想好怎么来吐槽自己这次苦逼的德邦物流过程了,只好来记一个流水账。 从寄快递开始: 2019年1月15日从 德邦物流 微信小app上下单,截图如下: 可笑的是什么,我预约的是17号上门收件,...

o0无忧亦无怖
昨天
5
0
Mac Vim配置

1.升级 vim   我自己 MacBook Pro 的系统还是 10.11 ,其自带的 vim 版本为 7.3 ,我们将其升至最新版: 使用 homebrew : brew install vim --with-lua --with-override-system-vim 这将下...

Pasenger
昨天
7
0
vmware安装Ubuntu上不了网?上网了安装不了net-tools,无法执行ifconfig?

1.重新设置网络适配器还是不行,如下指定nat 2.还需要指定共享网络,我是在无线环境下 3.无法执行ifconfig https://packages.ubuntu.com/bionic/net-tools到这个网站下载net-tools的deb文件...

noob_chr
昨天
3
0
解决SVN:E210007无法协商认证机制

svn:E210007 svn: Cannot negotiate authentication mechanism 执行下面代码即可 sudo yum install cyrus-sasl cyrus-sasl-plain cyrus-sasl-ldap...

临江仙卜算子
昨天
4
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部