贡献#
我们非常欢迎贡献!如果您对新教程有想法或建议,请提出一个 带有大纲的问题。
如果英语不是您的母语,或者您只能拿出一个草稿,请不要担心。开源是社区的努力。尽力而为——我们将帮助解决问题。
图像和现实生活中的数据使文本更具吸引力和力量,但请确保您使用的内容已获得适当的许可并可用。在这里,即使是一个粗略的艺术想法也可以被其他人打磨。
NumPy 教程是MyST-NB笔记本的精选集合 。这些笔记本用于生成静态网站,并且可以使用 Jupytext在 Jupyter 中作为笔记本打开。
注意:您应该使用CommonMark markdown 单元格。 Jupyter 仅渲染 CommonMark。
为什么选择 Jupyter 笔记本?#
在此存储库中选择 Jupyter Notebook 而不是主要 NumPy 文档中使用的常用格式 ( reStructuredText ) 有两个原因:
Jupyter 笔记本是交流科学信息的常见格式。
Jupyter笔记本可以在Binder中启动,以便用户可以与教程进行交互
rST 可能会给一些可能对贡献教程材料非常感兴趣的人带来障碍。
笔记#
您可能会注意到我们的内容采用 Markdown 格式(.md
文件)。我们以MyST-NB格式审查和托管笔记本。我们接受 Jupyter 笔记本 ( .ipynb
) 和 MyST-NB 笔记本 ( .md
)。如果您想将您的文件同步.ipynb
到您的.md
文件,请按照配对教程进行操作。
添加您自己的教程#
如果您有自己的 Jupyter 笔记本(文件)形式的教程.ipynb
,并且想尝试将其添加到存储库中,请按照以下步骤操作。
创建问题#
转到numpy/numpy-tutorials#issues并根据您的提案创建一个新问题。尽可能详细地说明您想要编写什么类型的内容(教程、操作方法)以及您计划涵盖的内容。如果适用,我们将尽力尽快回复评论。
查看我们建议的模板#
您可以使用此模板使您的内容与我们现有的教程保持一致:
上传您的内容#
请记住在上传之前清除笔记本上的所有输出。
分叉此存储库(如果您以前没有)。
在您自己的分支中,为您的内容创建一个新分支。
将您的笔记本添加到该content/
目录中。
environment.yml
使用教程的依赖项更新文件
(仅当您添加新的依赖项时)。
更新此内容README.md
以包含您的新条目。
创建拉取请求。确保选择“允许维护者编辑和访问机密”选项,以便我们可以正确审核您提交的内容。
????等待审核!
有关 GitHub 及其工作流程的更多信息,可以查看 此文档。