空间内的变更请求

了解如何在空间中对单个变更请求进行协作 — 包括如何审查、解决冲突和合并

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

创建变更请求

点击 编辑 按钮在 空间页眉 中开始新的变更请求。

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

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

一旦您对更改满意,您可以使用页眉栏中的按钮来 请求审阅 您的变更请求,或 合并 它直接到主分支。

使用 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 如果您决定不合并某个变更请求并希望将其从队列中移除,可以对其进行存档。 要存档变更请求,首先打开它。然后点击操作菜单 在变更请求标题旁并选择 存档 。您可以稍后通过打开 变更请求(Change Requests)菜单并选择“已存档”选项卡来查找并重新打开已存档的变更请求。

最后更新于

这有帮助吗?