手把手指导给开源项目贡献代码

Posted 雷学委

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了手把手指导给开源项目贡献代码相关的知识,希望对你有一定的参考价值。

很多新人学习了技术,但是没有地方施展。

问题不大,找几个开源项目来参加就可以了,需要开源项目磨练的可以联系学委。

本文重点讲解如何快速的给开源项目贡献代码。

首先你必要要有一个GitHub账号(或者Gitee/CSDN也行),然后找到开源项目,申请加入。或者fork模式参与开发。

对了,还没有安装ppc的直接运行下面命令:

pip install pypi-seed # pip install --upgrade pypi-seed 或者这个命令升级最近ppc
ppc # 运行pypiseed命令行查看使用帮助

本文基于pypi-seed演示,下面展示申请加入后的必备操作。

第一步 创建个人开发分支

比如参与到pypi-seed项目,先熟悉项目结构代码,然后进行贡献。
创建分支:dev-code-fix-0923 (分支名字需要自己记住,跟提交的功能有关即可)

第二步检出自己的开发分支

打开pycharm,检出整个pypi-seed代码:

git clone git@github.com:py4ever/pypi_seed.git

然后打开git视图:

第三步 本地开发并提交代码

在自己的分支上继续开发,然后commit 并push代码。

比如找到自己需要修改的代码,修改并commit(提交高效的修改描述信息),然后push上传代码到Github。

当然这里有一个非常重要的点:

运行测试,保证一切现有测试都运行通过!并为自己新增功能添加测试用例

我们打开Github网站能看到自己的分支

第四步 提交一个Pull Request申请开源项目的负责人进行审核合并

创建一个PR如下图:

提交完之后,可以找到项目的工作组或者负责人给他发送邮件,简单说一下本次提交的内容。(如果提交很多修改,请务必解释清楚)

本文展示的PR:

https://github.com/py4ever/pypi_seed/pull/1/files

打开可以看到提交的修改的详细信息,这次提交修改了公众号信息,截图如下。

总结

贡献代码给开源项目这个过程 = 验证自己的开源项目理解的一个过程,能够被合并发布,也是得到了项目方的认可的。

更多是一个前期准备,你需要理解熟悉这个项目,而不是胡乱修改就提交了(一般被否决或者无视了)

当然学委这里并没有展示一个需要花比较长时间开发才能合并的branch的操作,本文只是展示了一个开发的关键环节,算是最基本的提交了。更复杂的提交方式,这个以后会说。

文章都在这些专栏里面,喜欢Python的朋友,请关注学习 十年老将带你做开源项目 or Python基础专栏 or Python入门到精通大专栏

持续学习持续开发,我是雷学委!
编程很有趣,关键是把技术搞透彻讲明白。
创作不易,请关注收藏点赞,或者留下评论打打气!

以上是关于手把手指导给开源项目贡献代码的主要内容,如果未能解决你的问题,请参考以下文章

如何给Apache开源项目贡献代码

给顶级开源项目 Spring Boot 贡献代码是一种什么样的体验?

给顶级开源项目 Spring Boot 贡献代码是一种什么样的体验?

给顶级开源项目 Spring Boot 贡献代码是一种什么样的体验?

手把手教你如何加入到github的开源世界

参与 Apache 顶级开源项目的 N 种方式,Apache Dubbo Samples SIG 成立!