貢獻

為了持續改進,Peewee 需要像您這樣的開發人員的幫助。無論是貢獻修補程式、提交錯誤報告,還是只是提問和回答問題,您都在幫助 Peewee 成為一個更好的函式庫。

在這份文件中,我將描述一些您可以提供幫助的方式。

修補程式

您是否有新功能的想法,或者是否有想要改進的笨拙 API?在編寫程式碼並提交 Pull Request 之前,請在 GitHub 上開啟一個新 issue,描述您建議的變更。這不必是任何正式的東西,只需描述您想做什麼以及為什麼。

當您準備好時,您可以提交包含您的變更的 Pull Request。成功的修補程式應包含以下內容:

  • 單元測試。

  • 文件,包括文字形式和一般的API 文件

  • 程式碼在風格上與 Peewee 程式碼庫的其餘部分一致。

錯誤回報

如果您發現錯誤,請檢查該錯誤是否已被回報,如果沒有,請在 GitHub 上建立一個 issue。您提供的資訊越多,錯誤就能越快得到修復,因此請盡量包含以下內容:

  • 追溯和錯誤訊息(請格式化您的程式碼!)

  • 您程式碼的相關部分或重現錯誤的程式碼

  • Peewee 版本:python -c "from peewee import __version__; print(__version__)"

  • 您正在使用的資料庫

如果您在程式碼中發現錯誤並提交了失敗的測試案例,那麼我向您致敬,您是英雄!

問題

如果您對如何使用 peewee 做某些事情有疑問,那麼我建議您:

  • 在 StackOverflow 上提問。我幾乎每天都會查看 SO 上是否有新的 peewee 問題,並嘗試回答這些問題。這樣做的好處是可以為其他人保留問題和答案。

  • 在郵件清單上提問,https://groups.google.com/group/peewee-orm