完美的拉取请求#

注意

这完全复制自旧的 IPython wiki，目前正在开发中。本开发指南的许多信息已过时。

一份关于创建和审查拉取请求的简明指南。

1. 它能正常工作#

代码实现了它应有的功能！

IPython 必须能在以下平台上运行：

我们的大部分代码都涉及字符串和 Unicode。这需要以一种对 Unicode 敏感的方式完成，并且在 Python 2 和 3 上都能正常工作。这篇文章是对 Unicode 的一个很好的介绍。

编码风格指的是源代码的格式以及变量、函数、方法和类的命名方式。你的代码应该遵循我们的编码风格，其描述请见此处。

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

如果它修复了一个 bug，拉取请求最好能添加一个自动化测试，该测试在没有修复时失败，并在修复后通过。通常，复制现有测试并进行修改就足够了。新功能也应该附带自己的测试。关于测试 IPython 的详细信息可以在此处找到。

不要忘记更新文档字符串，以及官方文档中任何相关部分。新功能或重大更改也应在“新增功能”部分中记录。关于编写 IPython 文档的详细信息可以在此处找到。