五步让你成为知名高赞开源项目的贡献者(新手操作)

#1

以下操作理论上是可以针对任意你想参与的知名高赞开源项目,冒着被鄙视的风险整理完以下分享

适合首次尝试在github上提交pull requests

直接上核心步骤

一、前提

  • 1.本地已安装git且熟悉git命令

  • 2.已有github账号,且本地git邮箱和github已做关联

  • 3.本地电脑已安装vscode

二、访问github,找目标知名高赞开源项目fork到自己仓库,例:facebook/react

  • 1.打开浏览器访问github,搜索‘react’,进入目标项目,点击右上角Fork到自己仓库中

  • 2.git clone 当前自己Fork出来的react项目仓库

三、安装vscode插件Code Spell Checker代码拼写检查器

目的为我们快速定位开源项目中拼写错误的单词(注意:英语强的可忽略此步,改为肉眼核对)

四、在源码中找注解单词的错误,修改提交commit

为什么找注解单词的错误?因为注解单词错误的修改,风险最低,作者大佬合并PR的速度极度效率(更夸张的是你提交整个PR的过程,项目无需安装依赖包和运行单元测试,当然出于负责任的角度还是建议安装依赖和运行单元测试)

  • 1.使用vscode打开clone下来的项目

  • 2.随意打开源码中的文件(要多随意就有多随意),如果源码中有单词错误的,vscode插件Code Spell Checker会在对应单词下提示波浪线("environement": Unknown word。cSpell),再次强调建议查看注释里的单词,要找到注解错误单词还真得加运气成分

  • 3.修复,可打开google翻译核对,结合Code Spell Checker的提示,可快速修复单词,安全起见,可以选择错误比较明显的单词或也可以结合整个注解语句(选最有把握的单词,不要选造词,例如:libuv

  • 4.git commit提交,特别强调一点,建议到github对应开源项目找类似的单词修复且已经被合并的PR,参照commit格式提交

git add .
git commit -n -m"Fix typo in comment (environement → environment) " 

五、向开源项目提交PR

  • 1.新建fix分支,提交到自己fork的项目仓库中
git checkout -b fix-react-reconciler-comment
git push origin fix-react-reconciler-comment
  • 2.向开源项目提交Pull request,重点填写下对当前PR的功能描述,每个项目的PR描述格式不一样,同上述参照类似修复且已经被合并的PR的描述格式
## Summary

Fixed minor typo in comment.

environement → environment

  • 3.点击Create pull request

如果是首次提交项目PR,还需要签署对应的CLA

六、话外题

合并后的预览效果

操作完以上流程,恭喜你99.99%的概率已经成为目标知名高赞开源项目的contributor(当然需要静等开源作者的PR审核),那然后呢?

因为上述操作步骤理论上是可以针对任意你想参与的知名高赞开源项目,所有你可以选择你最中意的开源项目,个人建议选择和自己技术栈相关的

接着然后,你就可以稍加配置下自己的github门面

总结:

以上纯属玩玩,切不可滥用

终极期望:还是多拥抱开源项目,多学习源码

往期文章

基于qiankun微前端实战+部署粗略笔记(跳过原理)