贡献#

我们非常欢迎贡献!如果你有关于新教程的想法或提议,请提出一个带有大纲的议题

如果英语不是你的母语,或者你只能提供一个粗略的草稿,请不要担心。开源是一项社区工作。尽力而为——我们会帮助解决问题。

图片和真实数据使文本更具吸引力和影响力,但请确保你使用的内容已获得适当的许可并可用。同样,即使是粗略的艺术构思也能由他人完善。

NumPy 教程是精选的 MyST-NB Notebook 集合。这些 Notebook 用于生成静态网站,并可以使用 Jupytext 在 Jupyter 中作为 Notebook 打开。

注意:你应该使用 CommonMark Markdown 单元格。Jupyter 只渲染 CommonMark。

为什么选择 Jupyter Notebook?#

在此仓库中选择 Jupyter Notebook 而非 NumPy 主文档中常用的格式(reStructuredText)有两个原因

  • Jupyter Notebook 是交流科学信息的常用格式。

  • Jupyter Notebook 可以在 Binder 中启动,以便用户可以与教程互动。

  • reStructuredText (rST) 可能会对一些原本对贡献教程材料非常感兴趣的人构成障碍。

注意#

你可能会注意到我们的内容是 Markdown 格式(.md 文件)。我们以 MyST-NB 格式审查和托管 Notebook。我们同时接受 Jupyter Notebook(.ipynb)和 MyST-NB Notebook(.md)。如果你想将你的 .ipynb 同步到你的 .md 文件,请遵循配对教程

添加你自己的教程#

如果你有自己的 Jupyter Notebook 格式教程(一个 .ipynb 文件),并且想尝试将其添加到仓库中,请按照以下步骤操作。

创建议题#

前往 numpy/numpy-tutorials#issues 并创建包含你的提议的新议题。尽可能详细地说明你希望编写的内容类型(教程、操作指南)以及你计划涵盖的内容。如果适用,我们会尽快回复并给出评论。

查看我们建议的模板#

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

上传你的内容#

上传 Notebook 之前,请务必清除所有输出。

    派生(Fork)此仓库(如果你之前没有派生过)。
    在你自己的派生中,为你的内容创建一个新分支。
    将你的 Notebook 添加到 content/ 目录。

    使用教程的依赖项更新 environment.yml 文件(仅当你添加新依赖项时)。

    更新此 README.md 以包含你的新条目。
    创建拉取请求。请确保选中“允许维护者编辑和访问秘密”选项,以便我们能够妥善审查你的提交。

    🎉 等待审核!

有关 GitHub 及其工作流程的更多信息,请参阅此文档