コントリビューション

ormarへの全ての貢献を歓迎します!

問題

できるだけ簡単にお手伝いできるように、以下を含めてください。

• オペレーティングシステム
• Pythonバージョン
• Ormarバージョン
• データベースバックエンド(mysql、sqlite、postgresql)

ormarをインストールできない場合、または問題や機能の要求とは関係がないことがわかっている場合を除き、上記を常に含めるようにしてください。

リクエストリクエスト

プル要求の開始と作成は非常に簡単です。

!!!（注）変更が些細なもの（スペルミス、ドキュメントの調整など）でない限り、プルリクエストを作成する前に変更について話し合う質問を作成してください。

貢献をできるだけ簡単かつ迅速に行うには、テストとlintingをローカルで実行する必要があります。

Python3.6.2、3.7または3.8、詩、gitをインストールする必要があります。

#1.フォークとCDをリポジトリディレクトリにクローンする
gitクローンgit@github.com:<your username>/ormar.git
CDまたは

#2。ormar、依存関係、テスト依存関係をインストールする
詩のインストール-E dev

#3。新しいブランチをチェックアウトして変更を加える
git check out-bmy-new-feature-branch
#あなたの変更を加えてください。。。

#4。フォーマットとリンティング
#ormarは書式設定に黒、lintingにflake 8、タイプヒントチェックにmypyを使用します
#次のすべてを実行します。これらの呼び出しはすべて、プッシュごとにトラビスで実行されます。
黒のormarテスト
flake 8または
mypy ormarテスト

#5.Runテスト
#localhostすべてのテストがsgliteバックエンドに対して実行される
#残りのバックエンドはプッシュ後にチェックされます
pytest-svv--cov=ormar--cov=--cov-fail-under=100--cov-report=term-missing

#6.Buildドキュメント
mkdocsビルド
#ドキュメントを変更した場合は、正常にビルドされていることを確認してください。
#`mkdocs serve` を使用してドキュメントを提供することもできlocalhost:8000

#。。。 コミット、プッシュ、プルリクエストの作成

!!!ヒントormarがどのように機能するか、またその理由の詳細については、APIドキュメントを参照してください