在 codespace 中处理 GitHub Docs

关于 GitHub Codespaces

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

有关详细信息，请参阅“GitHub Codespaces 概述”。

在 codespace 中处理文档

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

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

2. 如果你是开放源代码参与者，请创建一个存储库的分支，然后从分支执行此过程的其余步骤。 有关详细信息，请参阅“创建存储库分支”。

3. 创建要处理的分支。 有关详细信息，请参阅“创建和删除仓库中的分支”。

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

   随即显示“设置 codespace”页面。 稍后，基于浏览器的 Visual Studio Code 版本显示。

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

   在大多数情况下，content 目录中文章的路径与 URL 中的路径匹配，只是少了 .md 文件扩展名。 例如，文章 https://docs.github.com/en/codespaces/getting-started/quickstart 的源是 Markdown 文件 content/codespaces/getting-started/quickstart.md。

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

7. 保存所做更改。

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

创建拉取请求

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

2. 单击“新建拉取请求”。

3. 如果你是开放源代码参与者，请单击“跨分支比较”，然后选择创建的分支存储库和工作分支。

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

4. 检查显示的更改是否包括你在 codespace 中所做的所有更改。 如果不是，这可能指示你还没有将一些更改从 codespace 推送到 GitHub。

5. 单击“创建拉取请求”****。

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

   拉取请求将由 GitHub Docs 团队的成员评审。