为什么我想参与开源?
我是一名前端开发工程师,React技术栈为主,最近对AI、Web3感兴趣。 想参与GitHub社区贡献,一方面想给简历加分,另一方面也想向强者们学习。 于是前几天用新的GitHub账号提交了第一个开源项目的PR,打算从0开始维护这个账号。
本文记录了这个过程,希望能给也想尝试的新人朋友一些参考。
第一步:找到合适的任务
怎么找开源项目?
我问了AI,它推荐了几个网站:
整体看下来都不错,但是对比第一个最顺眼,就选了它。
选定目标
当时筛选了语言和"good first issue"标签,按star数排序,最终看中了kana-dojo。
这是一个日语学习项目,任务很简单:在JSON文件中添加一句话。 对于第一次尝试来说,这个难度刚好。
这是相关的任务描述
认领任务
先看评论区——没人认领,Assignees也是空的。 然后我回复了:"I'd like to work on this"。
几分钟后,GitHub机器人就把任务指派给我了,还附带了帮助文档。 这个项目的自动化做得挺好。
第二步:动手修改
Fork仓库
首先fork项目,相当于在自己账号下复制一份代码。 我习惯fork后顺手点个⭐️收藏一下:)
回到自己主页,就能看到fork过来的项目了。 如果担心代码不是最新的,可以点"sync fork"更新一下。
修改文件
任务比较简单,直接在线编辑就行(如果需求复杂,就需要clone到本地了)。
修改完后我们保存提交,建议创建一个新的分支,将修改放到新分支上,这样比较符合规范。
提交pull request
保存后来到这个页面,我们创建一个新的pr,注意要从我们fork的仓库的新建的这个分支到目标仓库的main分支(这个开源仓库是pr提交到main)。 我们需要选择 compare cross forks才能从自己仓库的分支提交pull request到源仓库的目标分支。
选择正确的仓库仓库和分支,选择好后是这个样子
点击create pull request后,填入相关的信息,然后我们检查完代码和填写的内容后,创建Create pull request就好了。
之后在源仓库的pull requests里面就能找到我们刚才提交的pr了。
这个仓库设置了一些钩子校验,提交后会触发这些校验,其中有一些校验没通过,细致看下一个是自动化审核、另一个是vercel部署失败的校验。再看看其他人提交的pr,都会有这个问题,应该没什么问题,现在就等着这个pr被维护者review。
等待合并代码
发现很多的贡献者都遇到了这个 Community Contribution Auto-Review 校验不通过的问题,于是我们可以在这个pr中进行礼貌的提醒。
然后一会我们的邮箱就收到邮件,告诉我们commit已经合并到了main分支,在电脑上查看也是如此。
再看下我们的github账号的主页,下面会显示了完成第一次pr被merged的成就徽章
总结
这是个非常简单的任务,主要是为了熟悉一下维护开源项目的流程,虽然比较简单,但是整个过程也是收获不少。希望这次first pull request的记录可以帮到一些新人朋友。有什么问题欢迎随时留言交流!