在 Visual Studio 中创建拉取请求

如果你已通过 GitHub 或 Azure DevOps 身份验证并已将更改推送到远程存储库,则无需离开 Visual Studio 即可创建拉取请求。 拉取请求是 GitHub 和 Azure DevOps 中用于代码评审的重要工具。 这些评审有助于发现新功能中的问题,使团队成员能够分享他们在代码库不同区域的经验,从而改善代码库的整体健康状况。

注意

要试用该功能,请确保在“工具”>“选项”>“预览功能”>“拉取请求”中启用该功能

要创建拉取请求,请按照下列步骤操作:

  1. 在创建拉取请求之前,需要针对更改创建新分支。 此分支可将更改与主分支分开,直到可以合并更改为止。

  2. 然后,可以像平常在“Git 更改”窗口中那样提交推送更改。

  3. 选择通知横幅中的链接以“在 Visual Studio 中创建”或“在浏览器中创建”

    Visual Studio 2022 中“Git 更改”窗口的屏幕截图,其中显示了信息栏“已成功将 QP 推送到原点。拉取请求:在 Visual Studio 中创建或在浏览器中创建。”。

    或者,可以通过顶级菜单 Git > GitHub 或 Azure DevOps >“新建拉取请求”导航到“新建拉取请求”窗口,从远程分支创建拉取请求。 或者右键单击“Git 存储库”窗口中的分支。

    Visual Studio 2022 中的 Git 顶级菜单,选中了“GitHub”并突出显示“新建拉取请求”文本。

    或者,在“Git 存储库”窗口中选择分支以打开上下文菜单,然后选择“新建拉取请求”

    Visual Studio 2022 中的“Git 存储库”窗口,其中突出显示了传出/传入链接文本。

  4. 选择要合并到的分支,并为拉取请求提供描述性标题和说明。 可使用 markdown 语法设置 Visual Studio 中的拉取请求说明的格式。 尝试一下,在“说明”框中键入 Markdown 符号,然后选择“预览”按钮以预览 Markdown

    提示

    借助 Visual Studio 2022 版本 17.10 预览版 2 及更高版本和 GitHub Copilot 扩展,可以使用 AI 生成详细的拉取请求说明,描述所做的更改。 按闪光铅笔图标请求 GitHub Copilot 生成 PR 说明。 若要安装 GitHub Copilot,请参阅在 Visual Studio 中安装和管理 GitHub Copilot

    用于请求 GitHub Copilot 生成 PR 说明的闪光铅笔图标屏幕截图。

    Visual Studio 2022 中的“新建拉取请求”窗口,突出显示了预览按钮文本。

  5. 通过差异预览,你可以查看已作为拉取请求的一部分提交的文件中的所有更改。 请参阅比较文件 - 差异视图

    提示

    通过摘要差异视图选项,仅可查看代码的更改部分。

    Visual Studio 2022 中的“新建拉取请求”窗口,突出显示了摘要按钮文本。

  6. 可通过在问题搜索中引用工作项、在说明框中键入 # 或按右下角的 # 按钮来链接工作项。 还可添加审阅者,方法是键入其 GitHub 用户名或 Azure DevOps 标识或电子邮件。

    Visual Studio 2022 的说“新建拉取请求”,说明框中带有 #,并显示相关 GitHub 问题和拉取请求的列表。

  7. 在拉取请求上单击“创建”后,其他开发人员可以查看你的更改并提供反馈。 或者,使用 Visual Studio 17.12 及更高版本,单击下拉列表并选择“ 创建为草稿”。

    显示创建新拉取请求作为草稿的选项的屏幕截图。

使用 Visual Studio 17.12 及更高版本,可以启用拉取请求模板功能(在工具>选项>环境>预览功能中),以便在为 GitHub 和 Azure DevOps 创建新的拉取请求时,将使用存储库中的默认 PR 模板。 详细了解如何在 GitHub 文档Azure DevOps 文档中将拉取请求模板添加到存储库。

在编辑器中查看拉取请求注释

从 Visual Studio 17.11 开始,可以在不将上下文切换到浏览器的情况下查看评审者的意见和建议。

显示 PR 注释的屏幕截图。

若要启用此功能,请打开工具>选项>预览功能,并确保选中拉取请求注释

若要查看拉取请求的注释,请查看任何具有活动拉取请求分支的分支,然后从信息栏中选择在文件中显示注释。 还可以在 Git 更改窗口中选择 PR 编号,或从 Git 顶层菜单中选择 Git>GitHubAzure DevOps>在文件中显示注释

显示“Git 更改”窗口中查看注释的链接的屏幕截图。

可以使用工具栏中的图标在文件和单个注释之间导航,也可以使用以下键盘快捷方式:

操作 键盘快捷键
转到拉取请求中的上一个文件 Ctrl+Shift+Alt+F6
转到拉取请求中的下一个文件 Ctrl+Alt+F6
转到上一个注释 Ctrl+Shift+Alt+F8
转到下一个注释 Ctrl+Alt+F8

后续步骤

若要继续此旅程,请访问在 Visual Studio 中提取、拉取和同步页。

另请参阅