SciPy投稿人指南

本指南旨在帮助您在审阅了中的介绍性材料后,快速找到所需的有关SciPy开发的信息 做出贡献的方式 。如果您是新手,并且想要尽快开始编码,那么您已经找到了正确的位置。

  • 开发环境 -如何设置和维护开发环境,包括安装编译器和SciPy依赖项、在GitHub上创建SciPy存储库的个人分支、使用Git管理具有开发分支的本地存储库、执行SciPy的就地构建,以及创建将此开发版本的SciPy添加到Python路径的虚拟环境

  • 编辑SciPy -如何编辑SciPy Python代码,提供有关查找包含要编辑的SciPy功能的模块、向SciPy添加新模块以及遵守PEP8样式标准的提示

  • 单元测试 -如何使用pytest框架为SciPy编写和运行单元测试

  • 文档 -如何编写符合docstring标准的reStructiredText文档,使用Sphinx在本地构建文档,以及查看在持续集成检查过程中构建的文档

  • 基准 -如何使用空速对代码进行基准测试

  • 编译后的代码 -如何将快速编译的代码添加到SciPy

  • 持续集成 -我们的持续集成系统是如何工作的,如何调试您的公关

开发环境

编辑SciPy

单元测试

文档

  • Documentation style 包含有关编写文档字符串所需了解的所有内容,这些文档字符串被呈现为使用 Sphinx

  • 使用Sphinx渲染文档 在合并PR之前检查文档的更改是如何呈现的,这一点很重要;本文档解释了如何做到这一点

基准

编译后的代码