3分钟学会参与开源，提交 pr

pr 是什么

假设：

你在 GitHub 上发现了一个开源项目。
觉得项目中有 bug,或者写的不够好。
你想出手帮帮他。
这个时候就会用到 pr (pull request)。
这里翻译为：我改了你的代码，你快来看看把！

项目克隆到本地

首先找到一个项目，点击右上角的 Fork 按钮，把项目复制一份到自己的 GitHub。 ./image/1.png Fork 完之后我们到自己的仓库列表，找到刚刚复制的仓库，并 clone 到自己本地。 :::tip 这里要注意，一定是 clone 自己复制的那一份哦，而不是原仓库，没有人会让你直接更改别人代码的。 :::

在正式改代码之前我们还需要了解一下仓库的关系。我们现在拥有三份代码，称为三个仓库。

原作者 GitHub 上的仓库称为 upstream
Fork 复制到我们自己 GitHub 上的称为 origin
从我们自己 GitHub 上 clone 到本地的称为 local

在我们项目目录下执行 git remote -v 发现只有origin仓库。 ./image/3.png 这里用 git remote add upstream 原仓库地址 来添加upstream仓库。再次 git remote -v 查看添加成功。 ./image/4.png 至此，我们三个仓库就都关联上了。

如果要将upstream的同步到origin。可以采用如下的命令：

改代码

改别人代码之前我们还需要做一件事情，那就是基于 upstream 仓库创建一个新的分支。为什么这里需要创建新的分支呢，为一个分支在同一时间只能提交一个 pr 所以一般建议新建一个分支来提交 pr。

`1 2 3 4 5 6 7 8`	`// 获取到 upstream 仓库的 main 分支 git fetch upstream main // 切换到 upstream 仓库的 main 分支 git checkout upstream/main // 基于 upstream 仓库的 main 分支新建一个 feat-1 分支并切换 git switch -c feat-1`

好了终于可以修改代码了我们打开项目里仅有的 readme 文件，发现这里至少有两处错误，该大写的没大写，也不懂的使用三单。 ./image/5.png 经过我们一番修改后，看起来没有什么问题了。 ./image/6.png

提交

然后我们提交代码。

`1 2 3 4`	`git add . git commit -m 'fix:修复了一些语法错误' // 这里要指明提交的仓库和分支 git push origin feat-1`

提交成功后，打开 GitHub 我们 Fork 的仓库发现已经有提示了，我们点击右侧绿色按钮。 ./image/7.png 如果你没有看到提示，切换到我们刚刚提交的分支，点击这里进入。 ./image/8.png 总之我们进入到这个页面，按照项目要求填写标题和描述，点击右下角 Create pull request，来创建 pr。 ./image/9.png 提交后看到这个页面，就说明我们的 pr 已经提交成功了，等作者合并你的 pr 你就成为这个项目的 contributor 啦。 ./image/10.png