关于 GitHub Codespaces
GitHub Codespaces 允许您在远程托管的开发环境中工作,无需在本机上设置工作环境或下载文件即可快速入门。
更多信息,请参阅 GitHub Codespaces 快速入门。
在代码空间中处理文档
以下步骤假设您已经在 GitHub Codespaces 中设置了使用 Web 版 Visual Studio Code 编辑文件。如果您使用其他编辑器,步骤也非常相似。更多信息,请参阅 设置 GitHub Codespaces 默认编辑器。
-
前往 GitHub 文档的开源仓库
github/docs。 -
如果您是开源贡献者,请先 fork 该仓库,然后在您的 fork 上继续执行以下步骤。更多信息,请参阅 Fork 仓库。
-
创建一个用于工作的分支。更多信息,请参阅 在仓库中创建和删除分支。
-
在仓库的主页面,点击 代码,然后点击 在 BRANCH-NAME 上创建代码空间。
显示 “Setting up your codespace” 页面。稍后将显示基于浏览器的 Visual Studio Code 版本。
-
使用资源管理器导航到您想编辑的 Markdown 文件。如果该文件是文章,它位于
content目录。如果是可复用内容,则位于data目录。在大多数情况下,
content目录中文章的路径与 URL 中的路径相匹配,只是去掉了.md文件扩展名。例如,文章https://docs.github.com/en/codespaces/quickstart的源文件是content/codespaces/quickstart.md。 -
根据需要编辑 Markdown 文件。
-
保存更改。
-
提交并推送您的更改,可以使用源码控制视图,或在终端中使用 Git 命令。更多信息,请参阅 Git 简介。
创建拉取请求
-
前往
github/docs仓库的 “Pull requests”(拉取请求)标签页,地址为 github.com/github/docs/pulls。 -
点击 新建拉取请求。
-
如果您是开源贡献者,点击 跨 fork 比较,然后选择您创建的 fork 仓库和您的工作分支。
否则,将 “compare” 分支切换为您的工作分支。
-
确认显示的更改包含了您在代码空间中所做的所有更改。如果没有,可能是因为您尚未将代码空间中的更改推送到 GitHub。
-
点击 创建拉取请求。
-
填写拉取请求的详细信息,然后点击 创建拉取请求。
您的拉取请求将由 GitHub Docs 团队成员进行审阅。