使用 GitHub 拉取请求
拉取请求用于开源项目或部分企业工作流中,以管理贡献者的更改并在合并之前启动代码审查。
创建拉取请求后,您可以将想要推送到原始版本库的更改告知其他人,以便该版本库的维护者能审查这些更改,进行讨论并将其集成到基础分支。
创建拉取请求
在主菜单中,转到 。 拉取请求 工具窗口随拉取请求草稿一同打开。

或者,打开 拉取请求 工具窗口并单击右上角的
创建拉取请求…。

左侧的版本库为接收更新的 基础 版本库。
单击其名称并选择要应用更改的分支。

右侧的版本库是包含将添加到基础版本库的更改的 源 版本库。
单击其名称并选择包含要应用更改的分支。

如果您的项目使用了 多个远程版本库 ,也可以在该弹窗中更改源版本库。
在 更改自 中选择要包含在拉取请求中的提交记录。
双击任何文件名以打开差异视图并审查即将提交的更改。
在 标题 字段中指定拉取请求的名称,并可选地提供要通过该请求应用的更改描述。
可选择添加审阅者、为某人分配拉取请求或为其添加标签。
单击 创建拉取请求。
如果您尚未准备好推送拉取请求,可以将其保存为草稿。
单击
,该按钮位于 创建拉取请求 按钮旁边。
在打开的菜单中,选择 创建草稿拉取请求。
您的拉取请求将作为草稿出现在 GitHub 版本库中。 稍后可以通过在主菜单中选择 返回该请求。
如果您有一个 pull_request_template.md 文件,WebStorm 应将模板描述添加到您的拉取请求中。 有关模板的详细信息,请参阅 GitHub 文档。
管理传入的拉取请求
如果您是项目维护者,并且已为项目配置 GitHub 远程版本库,则可以直接在 WebStorm 中查看并管理传入的拉取请求。
要查看传入的拉取请求,请在主菜单中选择 。

使用 拉取请求 工具窗口执行以下操作:
按状态、作者、标签、负责人及审查状态对 请求进行筛选。
跳转至 GitHub 上的拉取请求 :选择拉取请求并在上下文菜单中选择 在浏览器中打开拉取请求。
查看建议更改与基础版本之间的差异 :点击拉取请求名称,选择文件并双击或按 Ctrl+D。
基于传入更改 创建本地分支 :打开拉取请求,点击包含传入更改的分支,并在上下文菜单中选择 检出“branch name”。

在 Git 工具窗口的 日志 标签页中 调查与分支相关的更改 :打开拉取请求,点击包含传入更改的分支,并在上下文菜单中选择 在 Git 日志中显示“branch name”。
这样可以帮助您浏览与该拉取请求相关的代码,并确保项目可以构建且测试通过。
解决合并冲突 :如果传入拉取请求中的分支存在合并冲突,可以直接在 拉取请求 工具窗口中,通过从目标分支创建合并提交或变基到目标分支进行解决。

为确保始终获取关于拉取请求的最新信息,请按 Ctrl+F5。 或者,右键点击拉取请求列表并选择 刷新列表。
审查拉取请求
当有需要您关注的更改时, 拉取请求 工具窗口将显示一个白点,而尚未查看的拉取请求将显示蓝点。

在主菜单中,转到 。
在拉取请求列表中,选择要处理的项目并双击它。
WebStorm 将打开所选拉取请求的概览。

标题旁边显示拉取请求编号。 如果想在 GitHub 上打开此拉取请求,请单击它。
单击 查看时间线 按钮打开拉取请求时间轴。
要筛选更改文件的列表,请在 更改自 中选择要查看的提交。
右键单击任意文件以打开该文件的上下文菜单。
如果审阅者留下了任何评论或建议,文件列表中将显示一个计数器,指示评论数量。
单击包含传入更改的分支,并在上下文菜单中选择 检出“branch name” 即可启动审阅模式。

选择要检查的文件,右键单击并在上下文菜单中选择 跳转到源代码 F4。

在打开的文件中,标尺栏中的粉色标记表示可供审阅的更改和评论。
单击标尺栏中的评论图标会隐藏或展开评论。

单击粉色标记将打开显示原始代码的弹出窗口。

将鼠标悬停在标尺栏上并单击
以留下评论。

对于建议,请添加您版本的代码,并用 Markdown 代码块包裹,语言指定为
suggestion。```suggestion Your suggestion for this code line ```
选择 添加单条评论 可立即发布评论并通知其他审阅者。
选择 开始审查 可添加多个评论。
在提交审阅之前,您的评论将被标记为 待处理 ,您可以编辑或删除它们。
如需对整个拉取请求添加总体评论,请打开该请求的时间轴视图。
准备结束审阅时,请在拉取请求概览中单击 提交。

或者,打开分支弹出窗口并单击 提交审查。
选择一个可能的结果:
批准 :用于批准合并更改。
请求更改 :用于提交反馈,拉取请求作者在合并前必须应用建议更改。
评论 :提交评论但不进行批准。
查看并应用建议的更改
如果原始存储库的维护者就您的更改留下了评论或建议,您可以直接在 WebStorm 中查看并应用它们。
在主菜单中,转到 。
在拉取请求列表中,选择要处理的项目并双击它。
WebStorm 将打开所选拉取请求的概览。
双击文件以查看建议更改和评论。
您可以解决评论、回复评论或留下您的反馈。

如果审阅者留下了建议,您将看到您的代码与建议代码的差异,并可以选择 本地应用 (将补丁应用到工作副本)或 提交 (打开提交消息弹出窗口)。

完成拉取请求的处理后,您可以重新请求审阅、合并请求或关闭该请求。
合并或关闭拉取请求
提交审阅并解决所有问题后,您可以合并或关闭拉取请求。
在主菜单中,转到 。
在拉取请求列表中,选择要处理的项目并双击它。
在概览底部,有一个合并选项按钮,具体内容取决于审阅流程的阶段。

如果您在审阅后已批准更新,可以单击 合并 来合并该拉取请求。
如需更多合并选项,单击
并选择 压缩并合并 来在合并前将更改的提交压缩为一个,或选择 变基 将拉取请求分支中的提交变基并添加到基础分支。
单击
更多 并选择 请求审查 如果您需要其他人对该拉取请求发表意见,或 关闭拉取请求 如果您不希望合并该请求。
如果您准备在未提交审阅的情况下合并拉取请求,请在拉取请求概览中单击
并选择 合并、 压缩并合并 或 变基。
