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