完美的拉取请求#

注意

这是从旧的 IPython wiki 直接复制过来的,目前正在开发中。开发指南的这一部分中的许多信息已经过时。

提交和审查拉取请求的简要指南。

1. 它有效#

代码如其所愿地工作了!

2. 它适用于 IPython 官方支持的所有平台#

IPython 需要工作于:

  • 各种类型的Linux,Windows & Mac

  • Python 2 和 3

3. 正确处理Unicode问题#

我们的代码库大部分处理字符串和Unicode。这需要在Python 2和3上都有效,并且要具备Unicode意识。[这篇文章](http://www.joelonsoftware.com/articles/Unicode.html) 是对Unicode的一个很好的介绍。

4. 遵循我们的编码风格#

编码风格指的是源代码的格式化方式以及变量、函数、方法和类的命名方式。您的代码应遵循我们的编码风格,具体描述在[[这里|Dev: Coding style]]。

5. 清洁 & 注释#

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

6. 已测试#

如果修复了一个错误,拉取请求理想情况下应添加一个自动化测试,该测试在没有修复时失败,而在有修复时通过。通常,复制一个现有测试并稍作调整即可。新功能也应附带其自己的测试。有关测试IPython的详细信息可以在[[这里|Dev: 测试]]找到。

7. 文档完善#

不要忘记更新文档字符串,以及 官方文档 中相关的部分。新功能或重大更改也需要在 What's New 部分中添加条目。有关记录 IPython 的详细信息可以在 [[这里|Dev: Documenting IPython]] 找到。