贡献#
我们非常欢迎贡献!如果你有一个新教程的想法或提案,请 提出一个议题 并附上大纲。
如果英语不是你的母语,或者你只能写出粗略的草稿,请不要担心。开源是一个社区的努力。尽你所能——我们会帮助解决问题的。
图像和真实数据使文本更加吸引人和有力,但请确保您使用的内容是适当许可并可用的。再次强调,即使是艺术作品的粗略想法也可以由他人完善。
NumPy 教程是 MyST-NB 笔记本的精选集合。这些笔记本用于生成静态网站,并且可以使用 Jupytext 在 Jupyter 中打开。
注意: 你应该使用 CommonMark markdown 单元格。Jupyter 仅渲染 CommonMark。
为什么选择 Jupyter Notebooks?#
在这个仓库中选择使用 Jupyter Notebook 而不是主 NumPy 文档中常用的格式([reStructuredText][rst])有两个原因:
Jupyter notebooks 是用于交流科学信息的常见格式。
Jupyter 笔记本可以在 Binder 中启动,以便用户可以与教程互动。
rST 可能对一些原本非常愿意贡献教程材料的人构成障碍。
注意#
你可能会注意到我们的内容是markdown格式(.md
文件)。我们审查和托管MyST-NB格式的笔记本。我们接受Jupyter笔记本(.ipynb
)和MyST-NB笔记本(.md
)。如果你想同步你的.ipynb
到你的.md
文件,请遵循配对教程。
添加你自己的教程#
如果你有一个以 Jupyter notebook 形式(一个 .ipynb
文件)的教程,并且你想尝试将其添加到仓库中,请按照以下步骤操作。
创建一个议题#
前往 numpy/numpy-tutorials#issues 并创建一个包含你提议的新问题。尽可能详细地说明你想写的内容类型(教程、操作方法)以及你计划涵盖的内容。如果适用,我们将尽快回复并提供评论。
查看我们建议的模板#
您可以使用此模板使您的内容与我们的现有教程保持一致:
上传你的内容#
在上传笔记本之前,请记得清除所有输出。
Fork this repository (if you haven't before).

In your own fork, create a new branch for your content.

Add your notebook to the content/
directory.

使用你的教程的依赖项更新 environment.yml
文件(仅在你添加新依赖项时)。
Update this README.md
to include your new entry.

Create a pull request. Make sure the "Allow edits and access to secrets by maintainers" option is selected so we can properly review your submission.

🎉 等待审核!
关于GitHub及其工作流程的更多信息,您可以查看[此文档][collab]。