贡献

为了持续改进,Peewee 需要像您这样的开发人员的帮助。无论是贡献补丁、提交错误报告,还是只是提出和回答问题,您都在帮助 Peewee 成为一个更好的库。

在此文档中,我将介绍一些您可以提供帮助的方式。

补丁

您是否有一个新功能的想法,或者有一个笨拙的 API 想改进?在编写代码并提交拉取请求之前,在 GitHub 上创建一个新问题,描述您建议的更改。这不必是任何正式内容,只需描述您想做什么以及原因即可。

准备就绪后,您可以提交包含更改的拉取请求。成功的补丁将具有以下内容

  • 单元测试。

  • 文档,包括散文形式和一般的 API 文档

  • 符合 Peewee 代码库其余部分风格的代码。

错误

如果您发现了一个错误,请检查它是否 已被报告,如果没有,请 在 GitHub 上创建问题。您包含的信息越多,错误修复得就越快,因此请尝试包含以下内容

  • 回溯和错误消息(请 格式化您的代码!)

  • 相关代码部分或用于重现错误的代码

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

  • 您正在使用的数据库

如果您在代码中发现了错误并提交了一个失败的测试用例,那么向您致敬,您是一位英雄!

问题

如果您对如何使用 peewee 做某事有疑问,那么我建议

  • 在 StackOverflow 上提问。我几乎每天都会查看 SO 以了解新的 peewee 问题,并尝试回答它们。这样做的好处还在于可以保留问题和答案,供其他人查找。

  • 在邮件列表中提问,https://groups.google.com/group/peewee-orm