空间中的变更请求

了解如何在某个空间内协作处理单个变更请求——包括如何审查、解决冲突和合并

当你处于某个 空间时,你可以通过打开新的变更请求来进行修改,或者浏览现有的变更请求,查看其他人在做什么。

创建变更请求

点击 编辑 按钮,位于 空间页眉 以开始一个新的变更请求。

这将打开一个新的变更请求,你可以根据需要编辑或删除内容。你的更改会自动保存,其他人也可以加入你的变更请求,与您实时协作。

在创建变更请求时,你可以添加标题和描述,为你所做的更改提供更多上下文。

你还可以将该变更请求链接到一个来源,包括:

  • Linear 问题

  • GitHub 拉取请求或问题

  • Jira 工单

  • 通用 URL

这些链接会显示在变更请求中,因此审阅者可以追溯这些工作的来源。

当你对更改感到满意后,可以使用标题栏中的按钮来 请求审阅 你的变更请求,或者 合并 直接将其合并到主分支。

使用 GitBook Agent 创建变更请求

GitBook Agent 是一个 AI 队友,可以 规划并实施变更请求 ,基于你给出的任何指令。

要使用 GitBook Agent 打开新的变更请求,请点击右上角、“编辑”按钮旁边的 GitBook Agent 图标,并告诉 GitBook 实现你想要的任何更改。

你可以让它做的一些事情包括:

  • 添加使用示例

  • 改进页面 SEO

  • 增强清晰度

  • 检查一致性

  • 修复拼写和拼写错误

  • 链接相关内容

  • + 更多

进入 使用 GitBook Agent 写作 了解更多。

预览变更请求

你可以通过点击 预览 选项在 空间页眉中预览你在变更请求中所做的更改。这将切换到已发布文档的预览,并包含拟议的更改,因此你可以在已发布文档的完整上下文中查看你的更改。

预览 按钮下方有一个用于网站预览的 URL。点击它,你的网站预览将会在新标签页中完整打开。

当你在新标签页中打开预览 URL 时,你还会看到 预览工具栏 位于浏览器窗口底部。使用此工具栏,你可以快速返回 GitBook 查看、编辑或评论该变更请求,或者打开你网站的实时版本。

circle-info

你只能预览添加到以下内容中的空间的变更请求: 已发布的文档站点.

circle-exclamation

请求审阅变更请求

当你想让团队成员在你将更改合并到主分支之前检查你的内容时,请对你的变更请求发起审阅请求。

选择 概览 空间标题栏中的标签页,以打开变更请求的概览——包括差异视图中的所有更改。

在这里,你可以为变更请求添加描述,以便给审阅者一些上下文,并标记你希望检查你工作的特定人员。

当你点击 请求审阅时,变更请求的状态将变为 审核中,并且你在审阅请求中标记的任何人都会收到通知。

如果你的更改不需要审阅,你拥有适当的 权限,并且你没有任何阻止性的 合并规则,你也可以直接将更改合并到主版本。

circle-info

将 GitBook Agent 添加为审阅者 到你的变更请求中,它可以检查你的内容中的拼写、语法和样式指南错误,并提出改进建议等。

circle-exclamation

差异视图

当你打开空间标题栏中的 更改 标签页时,差异视图就会显示出来。差异视图会突出显示变更请求中已编辑的每个页面和块。它会在目录中高亮显示任何已编辑的页面,并在页面中显示已添加、已编辑或已移除的具体块。

使用差异视图时有两个选项:

  1. 显示所有页面 — 这是差异视图的默认模式,它会在目录中同时显示已修改和未修改的页面。这样有助于在整个空间的上下文中查看哪些页面被编辑过。

  2. 仅显示已更改的页面 — 此模式只会在目录中显示已修改的页面,这有助于你专注于已更改的内容。对于拥有许多页面和子页面的大型空间,这尤其有用。

你可以切换到 更改 标签页,以在任何变更请求中检查差异视图。

合并变更请求

合并变更请求会将该变更请求中的更改添加到内容的主分支中,创建一个更新后的版本,并在空间的 版本历史.

如果你没有正确的 权限,或者你的变更请求尚未通过组织或空间的 合并规则.

更新变更请求

当你在变更请求中工作时,其他协作者可能会修改该空间的主分支。发生这种情况时,你的变更请求会被视为“已过期”——也就是说,主分支上有一些你在变更请求中看不到的内容。

你可能希望将这些新内容拉入你的变更请求中。如果出现以下情况,这会很有用:

  • 你想查看你的更改与主分支上的内容在全部组合后是什么样子。

  • 你需要将拉取的内容作为变更请求的一部分进行修改。

你可以通过按下 更新 来完成,位置在变更请求屏幕的标题中。

一旦你按下 更新,主分支中的所有内容都会拉入你的变更请求中。更新时你可能会遇到冲突——你可以在变更请求中解决它们。冲突解决后,变更请求会被视为已更新,更新按钮也会消失。

如果主分支再次发生变化,你的变更请求又会变为过期状态,更新按钮将再次出现。

在合并前要求编辑者确保他们的变更请求是最新的,是一种很好的质量控制——它有助于作者检查在变更请求合并后将进入主分支的确切内容。你可以通过一个 合并规则.

解决合并冲突

有时,当你想要合并一个变更请求时,你可能会发现主内容与您尝试合并的内容之间存在冲突。最简单地说,冲突就是一段无法自动合并的内容。

如果发生这种情况,你会看到一个冲突警报,以及在继续合并之前需要解决的冲突列表。

在解决合并冲突时,你有两个选择—— 选择要合并的版本手动 编辑内容.

选择要合并的版本

你可以通过选择你想要合并的版本来解决合并冲突——可以是传入的内容,也可以是之前存在的内容。这样你就可以在两个更改之间做出选择——要么是你最近的工作,要么是原始内容。

如果你处理的是可以通过这种方式解决的合并冲突,你可以选择要保留的版本,另一个版本将被删除。

手动编辑

如果你不想在版本之间做选择,可以通过手动编辑冲突来解决合并冲突。你可以删除不需要的块,甚至完全重写它们。一旦你对更改满意,就可以继续处理下一个冲突,直到全部解决。

归档变更请求

如果你决定不合并某个变更请求,并希望将其从队列中移除,你可以将其归档。

要归档变更请求,先打开它。然后点击 操作菜单 The Actions menu icon in GitBook ,位置在变更请求标题旁边,并选择 归档。之后你可以通过打开 变更请求 菜单并选择 已归档 标签页来查找并重新打开已归档的变更请求。

最后更新于

这有帮助吗?