完美的 Pull Request

注意

这是从旧的 IPython wiki 中逐字复制的，目前正在开发中。开发指南的这一部分中的许多信息已过时。

制作和审查拉取请求的简要指南。

1. 它有效

代码执行了它应该执行的操作！

2. 它在 IPython 正式支持的所有平台上有效

IPython 必须在以下平台上有效

• 各种 Linux、Windows 和 Mac

• Python 2 和 3

3. 正确处理 Unicode 问题

我们的许多代码库都处理字符串和 Unicode。这需要以一种 Unicode 感知的方式进行，并且可以在 Python 2 和 3 上运行。[这篇文章] (http://www.joelonsoftware.com/articles/Unicode.html) 是 Unicode 的一个很好的介绍。

4. 遵守我们的编码风格

编码风格是指源代码的格式化方式以及变量、函数、方法和类的命名方式。你的代码应遵循我们的编码风格，该风格在 [[此处|Dev: 编码风格]] 中进行了描述。

5. 清晰且带注释

代码应组织良好，并在适当的地方添加内联注释。当我们查看代码时，它应该清楚地说明它在做什么以及为什么这样做。它不应破坏我们在项目中建立的抽象。

6. 已测试

如果它修复了一个错误，则拉取请求理想情况下应添加一个自动化测试，该测试在没有修复的情况下失败，并在修复后通过。通常，复制现有测试并对其进行调整就足够了。新功能也应附带自己的测试。有关测试 IPython 的详细信息，请参阅 [[此处|Dev: 测试]]。

7. 文档齐全

不要忘记更新文档字符串和 官方文档 的任何相关部分。新功能或重大更改也需要在最新内容部分中添加一个条目。有关记录 IPython 的详细信息，请参阅 [[此处|Dev: 记录 IPython]]。