空间中的更改请求
了解如何在空间中围绕单个更改请求进行协作——包括如何审阅、解决冲突和合并
当你位于 空间中时,你可以通过打开一个新的变更请求来进行更改,或者浏览现有的变更请求,看看其他人在做什么。
创建变更请求
点击 编辑 按钮,位于 空间标题栏 中,开始一个新的变更请求。
这将打开一个新的变更请求,你可以根据需要编辑或删除内容。你的更改会自动保存,其他人也可以加入你的变更请求,实时协作。
创建变更请求时,你可以添加标题和描述,以便为所做的更改提供更多上下文。
你还可以将变更请求链接到来源,包括:
Linear 问题
GitHub 拉取请求或问题
Jira 工单
通用 URL
这些链接会显示在变更请求中,因此审阅者可以追溯这项工作的来源。
当你对更改满意后,可以使用标题栏中的按钮来 请求审阅 你的变更请求,或者 合并 它,直接进入主分支。
使用 GitBook Agent 创建变更请求
GitBook Agent 是一位 AI 队友,可以 规划并实施变更请求 ,基于你提供的任何指令。
要使用 GitBook Agent 打开一个新的变更请求,请点击右上角“编辑”按钮旁边的 GitBook Agent 图标,然后让 GitBook 实施你想要的任何更改。
你可以让它执行的一些操作包括:
添加使用示例
提升页面 SEO
增强清晰度
检查一致性
修复拼写和拼写错误
链接相关内容
+ 更多
前往 使用 GitBook Agent 写作 了解更多。
预览变更请求
你可以通过点击 预览 选项来预览你在变更请求中所做的更改,位于 空间标题栏中。这将切换到已发布文档的预览,并包含所提议的更改,因此你可以在已发布文档的完整上下文中查看你的更改。
在 预览 按钮下方有一个用于站点预览的 URL。点击它,你的站点预览会在新标签页中完整打开。
当你在新标签页中打开预览 URL 时,你还会在浏览器窗口底部看到 预览工具栏 。此工具栏可让你快速返回 GitBook,以查看、编辑或评论该变更请求,或者打开站点的实时版本。
你只能预览添加到 已发布文档站点.
的空间的变更请求。如果你的内容是通过共享链接或身份验证访问发布的,则不会显示预览功能。
在变更请求上请求审阅
当你希望在将更改合并到主分支之前,请团队成员检查你的内容时,请在变更请求上请求审阅。
选择 概览 选项卡,位于空间标题栏中,以打开你的变更请求概览——包括在 diff 视图中所做的所有更改。
在这里,你可以为变更请求添加描述,为审阅者提供一些上下文,并标记你希望检查你工作的特定人员。
当你点击 请求审阅时,变更请求的状态将变为 审核中,而你在审阅请求中标记的任何人都会收到通知。
如果你的更改不需要审阅,而且你拥有相应的 权限,并且没有任何阻止性的 合并规则,那么你也可以直接将更改合并到主版本中。
将 GitBook Agent 添加为审阅者 到你的变更请求中,它可以检查你的内容中的拼写、语法和样式指南错误,提出改进建议等。
如果你在审阅请求中没有标记任何人,那么所有拥有审阅者权限的人都会收到有关你请求的通知。如果空间中没有审阅者,则会通知审阅者之上的下一个角色。
Diff 视图
当你打开 更改 选项卡时,空间标题栏中将显示 diff 视图。Diff 视图会高亮显示变更请求中已编辑的每个页面和区块。它会在目录中高亮任何已编辑的页面,并在页面上显示已添加、编辑或删除的具体区块。
使用 diff 视图时有两个选项:
显示所有页面 – 这是 diff 视图的默认模式,它会在目录中同时显示已修改和未修改的页面。这有助于在整个空间的上下文中查看哪些页面被编辑过。
仅显示已更改的页面 – 此模式只会在目录中显示已修改的页面,这有助于你专注于已更改的内容。这在页面和子页面较多的大型空间中特别有用。
你可以切换到 更改 选项卡,以在任何变更请求中检查 diff 视图。
合并变更请求
合并变更请求会将该变更请求中的更改添加到内容的主分支,创建一个更新版本,并在空间的 版本历史.
,或者你的变更请求尚未通过你所在组织或空间的
更新变更请求
当你在变更请求中工作时,其他贡献者可能正在修改该空间的主分支。发生这种情况时,你的变更请求会被视为“过时”——主分支上有你在变更请求中看不到的内容。
你可能希望将这些新内容拉入你的变更请求中。这在以下情况很有用:
你想看看你的更改与主分支上的内容合在一起后会是什么样子。
你需要将拉取的内容作为变更请求的一部分进行修改。 更新 来实现这一点,位于变更请求页面的标题栏中。
一旦你按下 更新,主分支中的所有内容都会被拉入你的变更请求中。更新时你可能会遇到冲突——你可以在变更请求中解决它们。一旦冲突解决,变更请求就会被视为已更新,更新按钮也会消失。
如果主分支再次发生变化,你的变更请求又会变得过时,更新按钮也会重新出现。
在合并之前要求编辑者确保其变更请求是最新的,这是一个很好的质量控制措施——它有助于作者检查其变更请求合并后将进入主分支的确切内容。你可以通过一个 合并规则.
解决合并冲突
有时,当你想要合并变更请求时,可能会发现主内容与要合并的内容之间存在冲突。最简单地说,冲突就是无法自动合并的一段内容。
如果发生这种情况,你会看到一个冲突警告,以及在继续合并之前需要解决的冲突列表。
在解决合并冲突时,你有两个选项—— 选择要合并的版本 或 手动 编辑内容.
选择要合并的版本
你可以通过选择要合并的版本来解决合并冲突——可以是传入的内容,也可以是之前存在的内容。这样你就可以在一个更改和另一个更改之间进行选择——要么选择你最近的工作,要么选择原始内容。
如果你处理的是可以通过这种方式解决的合并冲突,你可以选择想要保留的版本,另一个版本将被删除。
手动编辑
如果你不想在不同版本之间做出选择,可以通过手动编辑冲突来解决合并冲突。你可以删除不需要的区块,甚至完全重写它们。一旦你对更改满意,就可以继续处理下一个冲突,直到全部解决。
归档变更请求
如果你决定不合并某个变更请求,并希望将其从队列中移除,可以将其归档。
要归档变更请求,先将其打开。然后点击 操作菜单 ,位于变更请求标题旁边,并选择 归档。稍后你可以通过打开 变更请求 菜单并选择 已归档 选项卡来查找并重新打开已归档的变更请求。
最后更新于
这有帮助吗?