pull request 入门

什么是pr。

一般情况下，在提到pr的时候，指的是pull request。

前置

默认了解的基础知识

• git的基本操作

一、官方定义

github给出的定义

提示

拉取请求可让你在 GitHub 上向他人告知你已经推送到存储库中分支的更改。 在拉取请求打开后，你可以与协作者讨论并审查潜在更改，在更改合并到基本分支之前添加跟进提交。

二、通俗理解

1. 作为使用者

假设我们正在使用一个在github维护的第三方代码库，发现其代码的一个bug（或者文档的错误）

提交一个pr是指: 按照github定义的方式，给指定的仓库提交一个代码变更请求，并且附带代码修改的详情。

如果仓库的管理者同意并合并了这个变更，我们就成功的更新了目标的代码库。

注意

在给别人的代码仓库提交pr时，强烈建议要按照对方仓库的要求开发，完成相应的测试代码，并编写足够的描述信息，这样可以提供大家的效率。

2. 作为维护者

假设我们在github上开源了一个很棒的项目，这时有人发现了一点小问题，并给我们提交了一个pr

提交一个pr是指：有人在github上，给我们的项目仓库提交了一个代码变更请求，并且附带代码修改的详情。

我们查看后可以选择拒绝或者合并到我们的代码库中（并给对方点个赞🎉）

三、步骤

以下步骤是以一个第三方仓库的使用者给维护者提交pr的角度来写的。

1. fork仓库到自己的github账号下
2. 在自己的仓库中更新目标代码（或者文档）并提交到自己的远程仓库
3. 在自己的github账号中，发起 New pull request，请求目标仓库的管理者合并自己的代码更新
4. 目标仓库的管理者同意合并代码，至此可以在对方的代码库中，看到自己的代码更新

四、实践

提示

实践一次，没什么难的~

1. fork仓库

操作对象：目标仓库的github主页

这里选择超级好用的vuepress主题 Vuepress Theme Hope 作为目标仓库来提交pr

相关信息

这里向Vuepress Theme Hope提交的pr是有实际意义的

如果只是练习的话，强烈建议向这个pr练习专用代码库提交pr，避免打扰他人

打开项目的github仓库主页

fork该项目到自己的github仓库

此时在自己的github仓库下，已经生成了一个新的同名的仓库

2. 更新代码

操作对象：自己github中 fork后生成的仓库

可以直接在github网站上编辑文件并提交；clone到本地编辑，再提交到自己账户的远程仓库也是ok的。

这里直接在github上编辑文件。

提交更新

注意

如果是更新代码，一定要在本地更新并测试代码，确实无误后再进行下一步。
这里是简单的举例，故略过。

3. New pull request

操作对象：自己github中 fork后生成的仓库

找到Pull Requests，点击New pull request

选择目标仓库与分支以及自己的仓库与分支，点击 New pull request

检查代码变更是否符合预期，确认无误后，点击Create pull request

详细且认真的填写标题和描述，确认无误后，点击Create pull request

4. 合并代码

提交成功后可以看到，这里要等待目标仓库的管理者审核并合并我们代码。

此时，在目标仓库的Pull reqests中，也可以看到我们提交的pr了。

在目标仓库管理员审核后，我们会收到pr的结果邮件（合并或拒绝），到这里一个pr就提交完成了。