Github如何为一个开源项目贡献自己的代码

末蓝、 2023-10-13 15:30 18阅读 0赞

## 前言 ##

大家都知道github上有各种各样的开源项目，例如许多著名的开源框架等；而参加一个开源项目能给我们带来许多，如提升自己的技术、增强了代码规范、提升自己的简历、增强了沟通能力和处理问题的能力等，这篇文章就来告诉大家如何为一个开源项目贡献自己的代码。

#### 一、首先我们要找到一个适合自己的项目 ####

在GitHub中有各种各样的项目使用的是不同的编程语言、不同的技术等，所以我们要先找到一个适合自己的项目，如果是新手那么可以先找一些入门级的项目或者在各种博客中推荐的开源项目中尝试贡献。

#### 二、查看这个项目的issue ####

在找到一个适合自己的开源项目后，我们可以点开它的issue查看所有带good first issue这个标签的issue。

![format_png][]

一般在这里项目管理会写出需要贡献的issue，我们可以在这里查看自己感兴趣的issue并且还没有被分配，并需要在这条issue下留言，接下来我们就需要等待管理员的分配。

#### 三、fork仓库 ####

如果管理员为你分配了任务，你首先需要fork这个仓库到你的仓库中

![format_png 1][]

> 记得修改gitbash里的用户名、邮箱等，然后git clone到本地，并且在开始写代码之前最好要保证自己的代码是最新的。

如何让代码是最新的呢 github中提供了sync fork这个按钮，在你fork来的仓库中点击就会让你的代码是最新的（还要在本地在拉取一次你的远程仓库）

![format_png 2][]

接下来就是创建分支开始你的贡献，记得做好提交的规范。

#### 四、提交和推送 ####

在我们写代码之前，我们需要看看项目中给贡献者说明的文件，里面会写一些注意事项，包括代码规范和编写代码的一些操作、流程、步骤等，我们需要遵守。

在写完一部分功能的代码后我们要根据不同的功能进行提交和推送，不要一次性提交，并且不同的项目有不同的提交格式我们需要遵守。

#### 五、pull request ####

在写完我们的代码之后我们就要开始pr，我们打开我们的GitHub远程仓库点击contribute按钮根据流程进行点击

![format_png 2][]

接下来就会有如下界面

![format_png 3][]

> 我们需要按照规范填写标题，同时你在**New Behavior**需要填写你代码测试用例，测试成功的截图等

> 并且在这里需要选择你提交的分支和你需要贡献到的分支

> 同时你需要在**Description**中填写你认领的issue，通过输入\#，就会弹出所有的issue，这是你需要选择你认领的issue。

最后一步就是点击Create pull request

#### 六、pr未通过有问题 ####

如果你的代码足够完美那么管理员大概会直接合并你的代码，如果有问题管理员会在你的pr中提出问题，这时候你就需要修改你的代码。

如果你觉得你的思路管理员没有明白，那么你可以在pr中评论跟管理员进行说明。

**那么代码修改完如何修改自己的pr呢？**

我们在修改完代码之后进行commit和push之后pr会随着你的提交自动更新（记得提交到你原来pr的分支），不需要再提一个pr，管理员可以在你pr中看到你做出的修改（记得提交要对应存在的问题）。

> 之后如果你的代码被merge到main主分支中，那么恭喜你，你成功成为了这个开源项目的贡献者之一。

### 总结 ###

这是我在参与一个开源项目中的经历，接下来我也会做一个自己的开源小项目，如果大家有兴趣可以关注一下一起参与。

[format_png]: https://img-blog.csdnimg.cn/img_convert/848be6a388c0b4c3853d9a38e755fb48.webp?x-oss-process=image/format,png
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/9fb09fb67e126b94b21f383233784c9b.webp?x-oss-process=image/format,png
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/d60ac7b23a1fa11765455fa45498d66a.webp?x-oss-process=image/format,png
[format_png 3]: https://img-blog.csdnimg.cn/img_convert/003de69d94c64599611f25bd3ca346e2.webp?x-oss-process=image/format,png