在 Codespace 中处理 GitHub Docs

关于 GitHub Codespaces

GitHub Codespaces 允许你在远程托管的开发环境中工作。你可以快速开始，无需设置工作环境或将文件下载到你的本地计算机。

有关更多信息，请参阅“GitHub Codespaces 概述”。

在 Codespace 中处理文档

以下步骤假定你已将 GitHub Codespaces 设置为使用 Visual Studio Code for Web 编辑文件。如果你已设置不同的编辑器，则步骤非常相似。有关更多信息，请参阅“为 GitHub Codespaces 设置默认编辑器”。

1. 导航到 GitHub Docs 的开源存储库，github/docs。

2. 如果您是开源贡献者，请创建仓库的一个分支，然后从您的分支中按照此过程中的其余步骤进行操作。有关更多信息，请参阅“Fork 存储库”。

3. 创建一个分支来处理。有关更多信息，请参阅“在存储库中创建和删除分支”。

4. 在存储库的主页上，单击 代码，然后单击在 BRANCH-NAME 上创建 Codespace。

   将显示“设置您的 Codespace”页面。在短时间后，将显示基于浏览器的 Visual Studio Code 版本。

5. 使用资源管理器导航到您想要编辑的 markdown 文件。如果该文件是一篇文章，它将位于 content 目录中。如果该文件是可重用内容，它将位于 data 目录中。

   在大多数情况下，content 目录中文章的路径与 URL 中的路径相匹配，减去 .md 文件扩展名。例如，文章 https://docs.github.com/zh-CN/codespaces/getting-started/quickstart 的源是 markdown 文件 content/codespaces/getting-started/quickstart.md。

6. 根据需要编辑 markdown 文件。

7. 保存您的更改。

8. 提交并推送您的更改，可以使用源代码管理视图，或使用终端中的 Git 命令。有关更多信息，请参阅“关于 Git”。

创建拉取请求

1. 导航到 github/docs 存储库的“拉取请求”选项卡，网址为 github.com/github/docs/pulls。

2. 单击新建拉取请求。

3. 如果您是开源贡献者，请单击跨分支比较，然后选择您创建的分支仓库和您的工作分支。

   否则，将“比较”分支更改为您的工作分支。

4. 检查显示的更改是否包含您在代码空间中所做的所有更改。如果不包含，这可能表明您尚未将更改从代码空间推送到 GitHub。

5. 单击创建拉取请求。

6. 输入拉取请求的详细信息，然后单击创建拉取请求。

   您的拉取请求将由 GitHub Docs 团队成员进行审核。