branch 是版本控制中的一项功能,用于指向你存储库中的特定提交。你的部署用分支,通常称为 main,代表用于构建线上文档的内容。除非你选择将它们合并到部署用分支,否则所有其他 branch 都与线上文档相互独立。
使用 branch 可以为文档创建独立环境,以便进行更改、接受评审,并在发布前尝试新方案。你的团队可以在各自的 branch 上并行更新文档的不同部分;在你发布更改之前,不会影响用户在你的线上站点上看到的内容。
我们建议在更新文档时始终基于 branch 工作,以保持线上站点稳定并启用评审工作流。
- 清晰命名 branch,便于队友了解你的工作内容。
- 合并后删除 branch,保持存储库整洁。
- 当你在进行可能影响他人工作的重大更改时,请提前告知团队。
- 在编辑器工具栏中选择分支名称(通常默认为
main)。
- 选择 New Branch。
- 为你的分支输入一个具有描述性的名称,例如
update-getting-started 或 fix-api-examples。
- 选择 Create Branch。
要在 branch 上保存更改,请在编辑器右上角选择 保存更改 按钮。此操作会创建一次提交,并将你的工作推送到该 branch。
- 在编辑器工具栏中选择 branch 名称。
- 从下拉菜单中选择要切换的 branch。
切换 branch 时,未保存的更改将会丢失。请在切换 branch 之前先保存或发布你的工作。