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