使用 GitHub Codespaces 进行 NumPy 开发#

本文档的这一部分将指导您完成以下内容:

  • 使用 GitHub Codespaces 作为您的 NumPy 开发环境

  • 在 GitHub 上创建 NumPy 仓库的个人 Fork

  • GitHub Codespaces 和 VSCode 桌面应用程序的快速浏览

  • 在 GitHub Codespaces 中处理 NumPy 文档

GitHub Codespaces#

GitHub Codespaces 是一项提供基于云的开发环境的服务,因此您不必在本地计算机上安装任何东西或担心配置.

什么是 codespace?#

codespace 是 Codespaces 的一个实例 - 因此是一个托管在云中的开发环境.每个 codespace 都在 GitHub 托管的虚拟机上运行.您可以根据需要的资源选择要使用的机器类型.有各种类型的机器可用,从 2 核处理器,4 GB RAM 和 32 GB 存储开始.您可以通过浏览器,Visual Studio Code,JetBrains Gateway 应用程序或使用 GitHub CLI 连接到 codespace.

Fork NumPy 仓库#

作为贡献者,处理 NumPy 代码库的最佳方式是首先创建一个仓库的 Fork.

  1. 浏览到 NumPy repository on GitHub 并 create your own fork .

  2. 浏览到您的 fork.您的 fork 将具有类似 inessapawson/numpy 的 URL,只是将 inessapawson 替换为您的 GitHub 用户名.

启动 GitHub Codespaces#

您可以从仓库主页上的绿色 “<> Code” 按钮创建一个 codespace 并选择 “Codespaces”,或者点击此链接 open .

工作区快速浏览#

您可以使用您选择的工具在 codespace 中开发代码:

  • 一个命令 shell,通过使用 GitHub CLI 发起的 SSH 连接._

  • 其中一个 JetBrains IDE,通过 JetBrains Gateway._

  • Visual Studio Code 桌面应用程序._

  • 基于浏览器的 Visual Studio Code 版本._

在这个快速入门中,我们将使用 VSCode 桌面应用程序作为编辑器.如果您以前没有使用过它,请参阅 Getting started VSCode docs 以熟悉此工具.

您的工作区将类似于下图:

使用 GitHub Codespaces 的开发流程#

本文档的 开发工作流程 部分包含有关 NumPy 开发流程的信息.在您开始贡献之前,请务必查看此内容.

渲染 NumPy 文档#

您可以在 构建 NumPy API 和参考文档 部分找到有关使用 Sphinx 渲染文档的详细文档.

文档在您的 codespace 初始化期间预先构建.因此,一旦此任务完成,您有两种主要选择可以在 GitHub Codespaces 中渲染文档.

常见问题解答和故障排除#

如果我不使用我的 codespace,它会保持活动状态多长时间?如果您在不交互的情况下让您的 codespace 运行,或者如果您在没有明确停止 codespace 的情况下退出 codespace,默认情况下,codespace 将在 30 分钟不活动后超时.您可以自定义为创建的新 codespace 设置超时时段的持续时间.

我可以回到之前的 codespace 吗?codespace 的生命周期从您创建 codespace 开始,到您删除它时结束.您可以断开连接并重新连接到活动的 codespace,而不会影响其正在运行的进程.您可以停止并重新启动 codespace,而不会丢失您对项目所做的更改.