贡献#
我们非常欢迎贡献!如果你有关于新教程的想法或建议,请创建一个 Issue并附上提纲。
如果英语不是你的母语,或者你只能提供一个粗略的草稿,也不要担心。开源是一个社区的努力。尽你所能——我们会帮助解决问题。
图片和真实数据使文本更具吸引力和说服力,但请确保你使用的是具有适当许可证且可用的内容。同样,即使是粗略的艺术构思也可以由其他人完善。
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
文件),并且你想尝试将其添加到仓库中,请按照以下步骤操作。
创建 Issue#
访问numpy/numpy-tutorials#issues并创建一个新的 Issue 来提出你的建议。尽可能详细地说明你想要编写的内容类型(教程、操作方法)以及你计划涵盖的内容。我们会尽快回复评论(如果适用)。
查看我们的建议模板#
你可以使用此模板使你的内容与我们现有的教程保持一致。
上传你的内容#
记住在上传笔记本之前清除所有输出。
Fork 此仓库(如果你之前没有这样做)。
在你自己的 Fork 中,为你的内容创建一个新的分支。
将你的笔记本添加到content/
目录。
更新environment.yml
文件,添加教程的依赖项(仅当添加新依赖项时)。
更新此README.md
以包含你的新条目。
创建一个pull request。 确保选中“允许维护者编辑和访问密钥”选项,以便我们可以正确审查你的提交。
🎉 等待审查!
有关 GitHub 及其工作流程的更多信息,你可以查看此文档。