如何给开源项目贡献代码

小鱼儿 2023-02-21 04:51 59阅读 0赞

和我比较熟的朋友知道我前几天给`prometheus`贡献了代码，这是第一次给一个比较大的开源项目贡献代码，后来一了解发现，我滴妈，好多人都不会发起`PR`请求来合并代码，这次我就好好写写，给大家一个参考。

毕竟没有什么比给开源项目贡献过代码更好的经历了，简历上写上去肯定会获得更多的关注，一起来吧！

![format_png][]

其中有三个新 名词 `fork` `pr` `ci` ，不要急，带着问题，我们慢慢来。

#### fork ####

第一步，找到你到贡献代码的项目，用`Fork`按钮，然后项目就会自动拷贝一份到你自己的`github`仓库。

![format_png 1][]

跑到你的`github`仓库里可以看到刚刚`frok`的项目。

![format_png 2][]

#### 准备发起PR ####

把你的项目`clone`下来，然后修改代码，再提交（如果有单元测试要完善，不然老外不会让你过的，一些大的开源项目都有单元测试，这是为了保证每个提交都是正常的，无论哪个分支一拉下来都不会报错，不仅节省人力，也体现了专业度）。

`commit` 结束后推送到远端（如果这些都不会的话，只能下来好好[补习下git][git]了）

进入到你的项目里，找到`Pull requests`（就是我说的`pr`），新建`pr`

![format_png 3][]

选择从哪个项目合并到哪个项目，注意箭头的指向

![format_png 4][]

下面的`pr`描述要改一下，这是老外最直接看到的东西（没想到我菜J的英语老外也能看得懂）

![format_png 5][]

注意要勾选`Allow edits from maintainers` 允许老外改动你的描述，如果你对你的英语语法和描述有足够的自信，可以不用勾选。

![format_png 6][]

#### 自动跑ci 并 修改ci报错 ####

点完上图右下角的`Create pull request`,有跑单元测试的脚本就自动开始运行了，他会监测你的每个步骤以及代码逻辑有没有问题，甚至完把这个提交的代码打包到不同的平台去跑测试，这就是 `ci`，中文是持续集成，现在稍微大点的团队要节省人力都得了解这个。

![format_png 7][]

如上图，我有两个点没有过，我们一个一个来，第一个`DCO`意思是我没有签名信息完善到`commit`信息里（不止是装X，也是为了背锅哈哈哈）

回到你的项目里，刚刚 `push`的分支上，执行下面的命令。

git commit --amend --signoff
    
     
      
     
      
       1

ok，自动创建了签名信息（注意必须和你的`github`账号邮箱一致，如果你用的密钥验证的方式 ，可能邮箱是错的，要手动改一下）

![format_png 8][]

然后强制推送到远程，这里相当重要，你千万不要创建新的`commit`，只针对最后一次提交做事情就好

git push --force-with-lease origin master
    
     
      
     
      
       1

![format_png 9][]

对于第二个`ci`问题，查看详情发现是代码风格不规范

![format_png 10][]

用`IDE`自带的`format`快捷键修复下就好了。按照下面的命令再强制推送一次。

![format_png 11][]

好了，慢慢等了。

![format_png 12][]

等到全部绿色就是所有的测试用例都跑过了

![format_png 13][]

咦！老外给我回复了。

#### 和老外讨论 ####

和他解释了一堆，最后因为老外觉得我要动到用户的配置，而且改动得到的功能点收益不是很大，所以没通过

![format_png 14][]

一旦老外通过了就会合并[你的代码啦][Link 1]。

不服了，我改了下代码，去掉了比较大的改动，[再来一次][Link 2]

根据老外的要求完善了文档（完善好再`commit --amend`，再强制`push`）

![format_png 15][]

合并进去啦！开心！！

![format_png 16][]

虽然不是什么大的功能改动，但是这种名垂千古的感觉还是很棒的，这篇文章讲了项目协作发起`pr`的整个过程，对远程开发的团队很有用，希望每一个看到这篇文章的人有所收获。

--------------------

本文转载自：[机智的小熊][Link 3]

[小熊][Link 3]是我比较敬佩的一个师兄，他的博客里面沉淀了很多知识、技巧、感悟等等，相信一定会对你有所帮助。

[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTQtMDIyNjA5LmpwZw?x-oss-process=image/format,png
[format_png 1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTQtMDIzMDM4LmpwZw?x-oss-process=image/format,png
[format_png 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTQtMDIyODMxLmpwZw?x-oss-process=image/format,png
[git]: https://mp.weixin.qq.com/s/J_2gDSmR19c1T3IafoEhcQ
[format_png 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTAtMTI0MzI1LmpwZw?x-oss-process=image/format,png
[format_png 4]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTAtMTI0MzQ4LmpwZw?x-oss-process=image/format,png
[format_png 5]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTAtMTI0MjMzLmpwZw?x-oss-process=image/format,png
[format_png 6]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTAtMTI0NDMzLmpwZw?x-oss-process=image/format,png
[format_png 7]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTAtMTI0NjM3LmpwZw?x-oss-process=image/format,png
[format_png 8]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTAtMTI1MDI0LmpwZw?x-oss-process=image/format,png
[format_png 9]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTQtMDI0OTQ2LmpwZw?x-oss-process=image/format,png
[format_png 10]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTAtMTI1NjM0LmpwZw?x-oss-process=image/format,png
[format_png 11]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTAtMTI1MTA4LmpwZw?x-oss-process=image/format,png
[format_png 12]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTAtMTI1OTUyLmpwZw?x-oss-process=image/format,png
[format_png 13]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTAtMTUzNDEyLmpwZw?x-oss-process=image/format,png
[format_png 14]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTEtMDM1MzQ3LmpwZw?x-oss-process=image/format,png
[Link 1]: https://github.com/prometheus/prometheus/pull/6953
[Link 2]: https://github.com/prometheus/prometheus/pull/6962
[format_png 15]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTEtMDg0MDU2LmpwZw?x-oss-process=image/format,png
[format_png 16]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9jb2RpbmczbWluLm9zcy1hY2NlbGVyYXRlLmFsaXl1bmNzLmNvbS9jb2RpbmczbWluLzIwMjAtMDMtMTQtMDMwMDEyLmpwZw?x-oss-process=image/format,png
[Link 3]: https://me.csdn.net/btnode