跳至主要内容

创建请求合并

创建请求以提出更改并协作处理存储库的更改。这些更改在分支中提出,这确保默认分支只包含已完成且已批准的工作。

谁可以使用此功能?

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

平台导航

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

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

注意:要在公共代码库中打开拉取请求,您必须对目标分支或源分支具有写入权限,或者对于组织拥有的代码库,您必须是拥有该代码库的组织的成员才能打开拉取请求。

您可以将拉取请求链接到某个问题,以表明修复正在进行中,并在有人合并拉取请求时自动关闭该问题。有关更多信息,请参阅“将拉取请求链接到问题”。

更改分支范围和目标代码库

默认情况下,拉取请求基于父代码库的默认分支。有关更多信息,请参阅“关于分支”。

如果默认父代码库不正确,您可以使用下拉列表更改父代码库和分支。您还可以使用下拉列表交换您的目标分支和基本分支,以建立参考点之间的差异。此处的引用必须是 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. 要创建可供审阅的拉取请求,请单击创建拉取请求。要创建草稿拉取请求,请使用下拉菜单并选择创建草稿拉取请求,然后单击草稿拉取请求。有关草稿拉取请求的更多信息,请参阅“关于拉取请求”。

提示:创建拉取请求后,你可以要求特定人员审阅你建议的更改。有关更多信息,请参阅“请求拉取请求审阅”。

拉取请求经过审阅后,可以合并到存储库

要了解有关 GitHub CLI 的更多信息,请参阅“关于 GitHub CLI”。

要创建拉取请求,请使用 gh pr create 子命令。

gh pr create

要将拉取请求分配给个人,请使用 --assignee-a 标志。你可以使用 @me 自行分配拉取请求。

gh pr create --assignee "@octocat"

要指定要将拉取请求合并到的分支,请使用 --base-B 标志。要指定包含拉取请求提交的分支,请使用 --head-H 标志。

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

要为新的拉取请求包含标题和正文,请使用 --title--body 标志。

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

要将拉取请求标记为草稿,请使用 --draft 标志。

gh pr create --draft

要向新的拉取请求添加标签或里程碑,请使用 --label--milestone 标志。

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

要将新的拉取请求添加到特定项目,请使用 --project 标志。

gh pr create --project octocat-project

要将个人或团队指定为审阅者,请使用 --reviewer 标志。

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

要在默认 Web 浏览器中创建拉取请求,请使用 --web 标志。

gh pr create --web
  1. 单击预览拉取请求。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 创建拉取请求,请选择下拉图标并单击创建拉取请求

  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. 将更改提交到存储库的本地副本后,单击创建 Pull Request图标。
    Screenshot of the top of the "Source Control" side bar. The pull request icon is highlighted with a dark orange outline.
  2. 检查您要从中合并的本地分支和存储库,以及您要合并到的远程分支和存储库是否正确。然后为 Pull Request 提供一个标题和一个描述。
    Screenshot of the "GitHub Pull Request" side bar with a form for creating a pull request, including "Title" and "Description" fields.
  3. 单击创建

有关在 GitHub Codespaces 中创建 Pull Request 的更多信息,请参阅“使用 GitHub Codespaces 进行 Pull Request”。

延伸阅读