贡献#
我们非常欢迎贡献!如果您对新的教程有想法或建议,请打开一个问题,并提供一个概述。
如果您英语不是母语,或者您只能提出一个粗略的草稿,请不要担心。开源是一种社区努力。尽力而为——我们会帮助解决问题。
图像和真实数据使文本更具吸引力和更强大,但请确保您使用的内容具有适当的许可证且可用。同样,即使是艺术作品的粗略想法也可以由其他人完善。
NumPy 教程是一个精选的MyST-NB 笔记本集。这些笔记本用于生成静态网站,并且可以使用Jupytext 在 Jupyter 中打开为笔记本。
注意:您应该使用CommonMark markdown 单元格。Jupyter 仅呈现 CommonMark。
为什么选择 Jupyter 笔记本?#
在这个仓库中选择 Jupyter 笔记本而不是主 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
,以包括您的新条目。
创建一个pull 请求。 确保选中“允许维护者编辑和访问机密”选项,以便我们能够适当地审查您的提交。
🎉 等待审查!
有关 GitHub 及其工作流程的更多信息,您可以查看此文档。