空间中的变更请求

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

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

创建变更请求

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

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

在创建变更请求时,你可以添加标题和描述,以便更好地说明你所做的更改。

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

使用 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 ,位于变更请求标题旁边,并选择 归档。之后,你可以通过打开 变更请求 菜单并选择 已归档 选项卡来找到并重新打开已归档的变更请求。

最后更新于

这有帮助吗?