SciPy 贡献者指南

本指南旨在帮助您在查阅了贡献方式或贡献者快速入门指南中的介绍性材料后，快速找到您所需的 SciPy 开发相关信息。

您也可以观看 SciPy 开发工作流程，这是一个关于如何修复 bug 并提交 pull request 的五分钟视频示例（注意：该视频录制于 2018 年，当时的构建步骤已有所不同，但整体工作流程仍然相同）。

• 从源代码构建 - 如何设置开发环境，包括安装编译器和 SciPy 依赖项，在 GitHub 上克隆 SciPy 仓库并更新 git 子模块，以及使用 spin 接口来构建和运行测试。

• 编辑 SciPy - 如何编辑 SciPy 的 Python 代码，包括查找包含待编辑 SciPy 功能的模块的技巧，向 SciPy 添加新模块，以及遵守 PEP8 风格标准。

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

• 文档 - 如何编写符合 docstring 标准的 reStructuredText 文档，使用 Sphinx 在本地构建文档，以及查看在持续集成检查期间构建的文档。

• 基准测试 - 如何使用 airspeed velocity 对代码进行基准测试。

• 编译代码 - 如何为 SciPy 添加快速的编译代码。

• 持续集成 - 我们的持续集成系统是如何工作的，以及如何调试您的 PR。

编辑 SciPy

• 开发工作流程 概述了在设置好开发环境后需要执行的操作。

• PEP8 和 SciPy 提供了一些确保代码符合 PEP8 标准的技巧。

• 用于开发的 Git 是一个关于如何使用 git 的指南，git 是一个分布式版本控制系统，用于管理世界各地对 SciPy 代码所做的更改。

• SciPy API 包含了一些关于 SciPy 代码组织方式的重要说明，并记录了 SciPy API 的结构；如果您将要导入其他 SciPy 代码，请先阅读此内容。

• 审查 Pull Requests 解释了如何在本地审查其他作者的 SciPy 代码。

• 问题分类和管理 解释了如何管理 issues 和 PRs，以及 GitHub 团队权限在 SciPy 中是如何工作的。

• 添加新的方法、函数和类 包含有关如何添加新方法、函数和类的相关信息。

• SciPy 核心开发者指南 包含背景信息，包括决策制定方式和版本准备过程；它面向 核心开发者，但也包含对所有贡献者都有用的信息。

• 代码和文档风格指南 - 缺失的部分 - 代码和文档风格指南。

测试

• 测试指南 是编写 NumPy 或 SciPy 代码单元测试的权威指南（属于 NumPy 文档的一部分）。

• 编写测试技巧 包含编写单元测试的技巧。

• 在本地运行 SciPy 测试 记录了 spin test 命令，该命令用于在本地构建 SciPy 并运行测试。

• 调试线性代数相关问题

文档

• 文档风格 包含您需要了解的关于编写 docstrings 的一切，这些 docstrings 使用 Sphinx 渲染生成 HTML 文档（属于 NumPy 文档的一部分）。

• 为 SciPy 文档做贡献 包含有关如何渲染和贡献 SciPy 文档的信息。

• 添加或编辑 Jupyter Notebook 形式的教程 解释了如何向 SciPy 文档添加 Jupyter notebook/MyST 格式的页面（交互式或非交互式）。

基准测试

• 使用 airspeed velocity 对 SciPy 进行基准测试 解释了如何使用 airspeed velocity 为 SciPy 添加基准测试。

编译代码

• 将 Cython 添加到 SciPy 使用 Cython 扩展和编译 Python 代码可以显著提高其性能；本文档帮助您入门。

• Python 之外的语言 讨论了在 SciPy 中使用 C、C++ 和 Fortran 代码。

• 公开的 Cython API 提供了关于暴露公开 Cython API 的指南。