本文详细介绍了如何参与开源项目及贡献代码的流程和注意事项,包括选择项目、fork仓库、克隆到本地、阅读贡献指南、提交代码、创建Pull Request等步骤,并强调了沟通礼仪、代码质量的重要性,适合初学者参考学习
1.如何参与开源项目
参与开源前提是自己有参加开源的意向以及有基本的技术能力,好的途径可以前往github中文网上看看自己感兴趣的方向的周或者月排行(一般是比较新兴的项目),或者可以去到ospp开源之夏看看有没有自己感兴趣的社区然后进去看看项目
上面就是一些常见的接触开源社区以及项目的途径
一般而言比较新兴的项目比较好参与并且贡献自己的代码,部分比较老的项目或者社区可能直接关闭了pr
2.贡献代码流程
1.首先fork项目到自己仓库
找到自己感兴趣的社区后,就能fork项目到自己的仓库中了(点击右上角的fork按钮)
这里直接点击Create fork按钮即可,随后就能在自己仓库中看到项目了
2.随后从自己仓库中clone项目到本地
在自己仓库中找到自己fork的项目,并且点击clone复制链接,在本地克隆库打开即可
点击clone Repository后,直接输入url后点击clone即可拉到本地了
3.阅读在项目中的贡献指南(一般是contributing.md和readme.md文件)
这两个文件能够指点你如果想要贡献代码,你应该怎么做,例如你的分支应该怎么命名,你的PR的命名规则等等,查看并且保证自己按照文件做的才可能让自己的PR被接受哦
readme一般是让你快速了解项目内容,技术栈等等内容的
4.去到issue认领任务后并且开始后续开发
在项目首页可以找到issue,里面有部分是需要后续开发以及修复的功能,可以根据自己的需要去到issue下评论例如:
我对该issue非常感兴趣,能将该任务分配给我吗(只要礼貌一点就好啦)
随后等待项目的维护者同意后你就能进行开发了(其实不用等到同意也可以开始,不过可能分配给别人做)
当让你也可以自己在研究项目的时候自己发现bug自己提出issue然后自己修改代码后提交
5.按照contribution文件或者其他标准完成开发并且提交内容
你在解决Issue,修改代码后就能提交代码了,但是注意注意提交代码时的提交消息有格式要求!
假如你是修复bug需要这样 fix(你修改的地方或者bug介绍) 举例 fix(index.ts) fix(修复了首页显示错误的问题)假如你是添加新功能 feat(新功能的名字) 举例 feat(新增了文章页面)假如你是修改项目文档网站的内容 docs(修改的地方或者修改的介绍) docs(index.ts)
然后在后面加个冒号写你代码实现的功能或者作用 举例 docs(index.ts):修改了错误的类型提示
常用的分类就是以上几个。
然后详细介绍内容需要你尽可能详细的表达你贡献的代码的作用
例如
随后点击commit and push即可
提交成功后可以在自己的仓库中看到按钮
表明你比拉取过来的项目的分支领先(也就是你进行了修改并且推送到了自己仓库中了)
随后点击contribute后再点击Open pull request
随后就会出现以下的界面了,再这里你可以添加对自己修改的代码的一些描述,当然这里的描述一般再contribution文件中也是有规定的了,如果没有也经可能规范一些填写就行
最后就是美美点击右下角按钮创建PR等待管理者接受并且合并即可啦
3.注意事项
1.沟通要礼貌,表达意思要准确。
2.代码质量和逻辑要过关,不然审核代码不会给你通过的。
3.注意注意要仔细看contribution文件内容,不然审查不过自己努力就白费了
最后就是欢迎提问了