寄稿

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