创建拉取请求

创建 PR 以提出更改并与他人协作，对存储库进行更改。这些更改在分支中提出，这可确保默认分支仅包含已完成且已批准的工作。

谁可以使用此功能？

任何具有存储库读取权限的人都可以创建 PR。

平台导航

本文内容

如果你想为你的 PR 创建一个新分支，但没有对存储库的写入权限，你可以先分叉存储库。有关更多信息，请参阅“从分叉创建 PR”和“关于分叉”。

创建 PR 时，你可以指定要将你的更改合并到哪个分支中。PR 只能在两个不同的分支之间打开。

注意：要在公共存储库中打开 PR，你必须具有对头分支或源分支的写入权限，或者对于组织拥有的存储库，你必须是拥有该存储库的组织的成员才能打开 PR。

你可以将 PR 链接到一个 issue，以显示修复正在进行中，并在有人合并 PR 时自动关闭该 issue。有关更多信息，请参阅“将 PR 链接到 issue”。

更改分支范围和目标存储库

默认情况下，PR 基于父存储库的默认分支。有关更多信息，请参阅“关于分支”。

如果默认父级存储库不正确，您可以使用下拉列表更改父级存储库和分支。您还可以使用下拉列表交换您的头分支和基础分支，以建立参考点之间的差异。此处的引用必须是 GitHub 存储库中的分支名称。

Screenshot of a pull request. The dropdown to edit the compare branch is expanded.

在考虑分支时，请记住基础分支是应用更改的位置，头分支包含您希望应用的内容。

当您更改基础存储库时，您也会更改拉取请求的通知。下次登录时，所有可以推送至基础存储库的人员都将收到电子邮件通知，并在其仪表板中看到新的拉取请求。

当您更改分支范围中的任何信息时，提交和已更改文件预览区域将更新以显示您的新范围。

提示:

  • 使用比较视图，您可以在任何时间范围内设置比较。有关更多信息，请参阅“比较提交”。
  • 项目维护者可以为存储库添加拉取请求模板。模板包括拉取请求正文中信息的提示。有关更多信息，请参阅“关于问题和拉取请求模板”。

创建拉取请求

  1. 在 GitHub.com 上，导航到存储库的主页。

  2. 在“分支”菜单中，选择包含您的提交的分支。

    Screenshot of the branch dropdown menu on the main page of a repository.

  3. 在文件列表上方，在黄色横幅中，单击比较和拉取请求为关联分支创建拉取请求。

    Screenshot of the banner above the list of files.

  4. 使用基础分支下拉菜单选择您要将更改合并到的分支，然后使用比较分支下拉菜单选择您进行更改的主题分支。

  5. 为您的拉取请求键入标题和描述。

  6. 要创建可供审阅的拉取请求，请单击创建拉取请求。要创建草稿拉取请求，请使用下拉菜单并选择创建草稿拉取请求，然后单击草稿拉取请求。有关草稿拉取请求的更多信息，请参阅“关于拉取请求”。

提示：创建 Pull Request 后，你可以要求特定人员审阅你建议的更改。有关更多信息，请参阅“请求 Pull Request 审阅”。

Pull Request 经过审阅后，可以合并到存储库。

要详细了解 GitHub CLI，请参阅“关于 GitHub CLI”。

要创建 Pull Request，请使用 gh pr create 子命令。

gh pr create

要将 Pull Request 分配给个人，请使用 --assignee 或 -a 标志。你可以使用 @me 为自己分配 Pull Request。

gh pr create --assignee "@octocat"

要指定要将 Pull Request 合并到的分支，请使用 --base 或 -B 标志。要指定包含 Pull Request 提交的分支，请使用 --head 或 -H 标志。

gh pr create --base my-base-branch --head my-changed-branch

要为新的 Pull Request 包含标题和正文，请使用 --title 和 --body 标志。

gh pr create --title "The bug is fixed" --body "Everything works again"

要将 Pull Request 标记为草稿，请使用 --draft 标志。

gh pr create --draft

要向新的 Pull Request 添加标签或里程碑，请使用 --label 和 --milestone 标志。

gh pr create --label "bug,help wanted" --milestone octocat-milestone

要将新的 Pull Request 添加到特定项目，请使用 --project 标志。

gh pr create --project octocat-project

要将个人或团队分配为审阅者，请使用 --reviewer 标志。

gh pr create --reviewer monalisa,hubot  --reviewer myorg/team-name

要在默认网络浏览器中创建 Pull Request，请使用 --web 标志。

gh pr create --web

  1. 单击预览 Pull Request。GitHub Desktop 将打开一个预览对话框，显示当前分支和基本分支之间的更改差异。

    Screenshot of the "No local changes" view. A button, labeled "Preview Pull Request", is highlighted with an orange outline.

    Screenshot of the "No local changes" view. A button, labeled "Preview Pull Request", is highlighted with an orange outline.

    或者，要直接转到 GitHub 创建 Pull Request，请选择下拉图标并单击创建 Pull Request。

  2. 确认基本：下拉菜单中的分支是你希望将更改合并到的分支。

    Screenshot of the "Open a Pull Request" dialog window. A button with a dropdown icon, labeled "base: development", is outlined in orange.

    GitHub Desktop 将告知你当前分支是否可以自动合并到基本分支。

    Screenshot of the "Open a Pull Request" dialog window. A status label stating "Can't automatically merge" is highlighted with an orange outline.

  3. 单击创建 Pull Request。GitHub Desktop 将打开你的默认浏览器，带你到 GitHub。

  4. 为您的拉取请求键入标题和描述。

  5. 要创建可供审阅的拉取请求，请单击创建拉取请求。要创建草稿拉取请求，请使用下拉菜单并选择创建草稿拉取请求，然后单击草稿拉取请求。有关草稿拉取请求的更多信息，请参阅“关于拉取请求”。

  1. 在将更改提交到存储库的本地副本后，单击创建拉取请求图标。
    Screenshot of the top of the "Source Control" side bar. The pull request icon is highlighted with a dark orange outline.
  2. 检查要从中合并的本地分支和存储库以及要合并到的远程分支和存储库是否正确。然后为拉取请求提供标题和说明。
    Screenshot of the "GitHub Pull Request" side bar with a form for creating a pull request, including "Title" and "Description" fields.
  3. 单击创建。

有关在 GitHub Codespaces 中创建拉取请求的更多信息，请参阅“使用 GitHub Codespaces 进行拉取请求”。

延伸阅读