贡献¶

我们非常欢迎您的贡献！如果您有关于新教程的想法或建议，请打开一个 issue 并附上大纲。

如果英语不是您的母语，或者您只能写一个粗略的草稿，请不用担心。开源是一项社区共同的努力。尽力而为——我们会帮助您修正问题。

图片和真实数据能使文本更具吸引力和说服力，但请确保您使用的内容拥有适当的许可并可以公开。同样，即使只是一个粗略的艺术品想法，也可以由他人进行打磨。

构建网站¶

快速入门¶

设置开发环境，并安装 `requirements.txt` 和 `site/requirements.txt` 中列出的依赖项。例如，可以使用内置的 venv 模块。

python -m venv np-tutorials
source np-tutorials/bin/activate
python -m pip install -r requirements.txt -r site/requirements.txt

然后可以使用以下命令构建网站：

jupyter-book start --execute

这将执行所有 notebook 并启动一个 Web 服务器以在本地查看渲染后的内容。在您偏好的浏览器中打开 `localhost:30xy`（确切的端口号将在您的终端中显示）即可查看渲染后的网站。

添加您自己的教程¶

如果您有自己的 Jupyter notebook（`.ipynb` 文件格式）形式的教程，并希望将其添加到仓库中，请遵循以下步骤。

创建 Issue¶

前往 https://github.com/numpy/numpy-tutorials/issues 并创建一个新的 issue 来提交您的建议。尽可能详细地说明您想编写的内容类型（教程、操作指南）以及您计划涵盖的主题。我们会尽快回复，并附上相关评论（如果适用）。

参考我们的建议模板¶

您可以使用此模板来确保您的内容与我们现有的教程保持一致。

上传您的内容¶

请记住在上传 notebook 之前清除所有输出。

• Fork 该仓库（如果您之前没有做过）。

  
• 在您自己的 fork 中创建一个新分支来存放您的内容。

  
• 将您的 notebook 添加到 `content/` 目录。

  

在 `environment.yml` 文件中添加您教程所需的依赖项（仅当您添加了新依赖项时）。

更新此 `README.md` 文件以包含您的新条目。

创建一个 pull request。请确保选择了“允许维护者编辑和访问机密”选项，以便我们能够正确审查您的提交。

🎉 等待审查！

有关 GitHub 及其工作流程的更多信息，您可以参阅本文件。