完美的拉取請求#

注意

這完全複製自舊的 IPython wiki，目前正在開發中。本開發指南的許多資訊已過時。

一份關於建立和審查拉取請求的簡明指南。

1. 它能正常工作#

程式碼實現了它應有的功能！

IPython 必須能在以下平臺上執行：

我們的大部分程式碼都涉及字串和 Unicode。這需要以一種對 Unicode 敏感的方式完成，並且在 Python 2 和 3 上都能正常工作。這篇文章是對 Unicode 的一個很好的介紹。

編碼風格指的是原始碼的格式以及變數、函式、方法和類的命名方式。你的程式碼應該遵循我們的編碼風格，其描述請見此處。

程式碼應該組織良好，並在適當的地方有內聯註釋。當我們檢視程式碼時，應該清楚它正在做什麼以及為什麼。它不應該破壞我們在專案中建立的抽象。

如果它修復了一個 bug，拉取請求最好能新增一個自動化測試，該測試在沒有修復時失敗，並在修復後透過。通常，複製現有測試並進行修改就足夠了。新功能也應該附帶自己的測試。關於測試 IPython 的詳細資訊可以在此處找到。

不要忘記更新文件字串，以及官方文件中任何相關部分。新功能或重大更改也應在“新增功能”部分中記錄。關於編寫 IPython 文件的詳細資訊可以在此處找到。