核心 Git 概念
Repository
Repository
你的文档源码所在位置,存放所有文件及其历史。Web 编辑器会连接到你的存储库以访问并修改内容。
Commit
Commit
在特定时间点保存的更改快照。每次提交都会包含描述更改内容的消息,并在项目历史中创建永久记录。
Branch
Branch
branch 指向存储库中的特定提交。你的在线文档是从部署用分支构建的。你可以有任意数量的其他 branch,这些 branch 上的更改尚未发布到在线文档。如果你想将某个 branch 的更改纳入在线文档,可以通过拉取请求将该 branch 合并到部署用分支。使用 branch 可以在不影响在线文档的情况下开展工作,安全试验新功能,并在发布前获取评审。
Deployment branch
Deployment branch
项目的主 branch,你的在线文档内容由此构建。对该 branch 的更改会自动发布到文档站点。通常命名为
main
,但你可以将任意 branch 设为部署用分支。Pull request
Pull request
在某个 branch 上提出将更改合并进在线文档的一种方式。支持在更改上线前进行评审与讨论。通常称为 PR,在 GitLab 中也称为合并请求。
Diff
Diff
diff(差异)展示文件两个版本之间的更改。在审查拉取请求时,diff 会高亮新增、删除或修改的内容,便于识别具体变化。
Web 编辑器如何使用 Git
- 打开文件:编辑器会从你的存储库获取最新版本,确保你始终在处理最新内容。
- 进行更改:编辑器会将你的更改作为草稿进行跟踪,当你准备保存时可生成一次提交。
- 保存更改:编辑器会基于你的更改创建一次提交,将你的工作保存在项目历史中。
- 创建 branch:编辑器会在你的存储库中创建一个新的 branch,任何具有存储库访问权限的人都可以使用它来协作并审阅更改。
- 在你的部署用分支上发布:编辑器会直接向你的部署用分支提交并推送,从而立即发布你的更改。
- 在其他分支上发布:编辑器会创建一个拉取请求(PR;亦称“合并请求”/Merge Request),以便你在将更改合并到部署用分支之前先获取他人的反馈。
Git 最佳实践
- 编写有信息量的提交消息:使用主动语态,具体说明修改了什么。
- 使用具描述性的 branch 名称:branch 名称应能说明所做的工作,并让查看你存储库中分支的人一目了然。
- 保持分支聚焦:让某个 branch 上的变更聚焦于一个特定任务或项目。
- 合并后删除分支:在不再需要时删除分支,保持存储库整洁。