空间中的变更请求

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

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

创建变更请求

点击 编辑 按钮,位于 空间标题栏 ,即可开始新的变更请求。

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

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

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

  • 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. 仅显示已更改的页面 – 此模式只会在目录中显示已修改的页面,这有助于你专注于已更改的内容。这在拥有大量页面和子页面的大型空间中特别有用。

你可以切换到 更改 选项卡,以在任何变更请求中查看差异视图。

合并变更请求

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

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

更新变更请求

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

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

  • 你想看看当所有内容合在一起时,你的更改和主分支上的内容会是什么样子。

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

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

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

如果主分支再次发生更改,你的变更请求又会变为非最新,更新按钮也会重新出现。

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

解决合并冲突

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

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

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

选择要合并的版本

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

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

手动编辑

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

归档变更请求

你不能在 GitBook 中删除变更请求,但可以将其归档。

要归档变更请求:

  1. 打开 变更请求 选项卡。

  2. 选择你想要归档的变更请求。

  3. 点击 操作 菜单 The Actions menu icon in GitBook ,位于变更请求标题旁边,然后选择 归档.

要查找并重新打开已归档的变更请求,请打开 变更请求 菜单并选择 已归档 选项卡。

最后更新于

这有帮助吗?