Pythonパッケージの開発ガイドに含めるべき内容#
理想的には、あなたのパッケージは開発ガイドを持つべきです。 このファイルはあなたのパッケージのドキュメントにあり、 CONTRIBUTING.mdファイル(前述)からリンクされるべきです。 開発ガイドは、技術的に熟達したユーザに対して、以下の方法を明確に示すべきです:
開発環境をローカルにセットアップし、パッケージで作業できるようにする
テストスイートの実行
ドキュメントをローカルにビルドする
開発ガイドには、次のようなガイドラインもあるはずです:
docstringスタイルを含むコード標準、コードフォーマットと、パッケージが従う特定のコードアプローチ。
また、既存のテストスイートではカバーできないような新機能や既存機能の変更をコントリビューターが提出する場合、要求するテストの種類を指定しておくと便利です。
もし文書化する時間があれば、メンテナのワークフローやリリースプロセスを文書化することも有用です。
開発ガイドが重要な理由#
開発ガイドを持つことは価値があります、もしそうしたいのであれば:
新しいメンテナーを迎える。
技術志向のコントリビューターが、あなたのリポジトリに対して、思慮深く有用なコードベースのプルリクエストを行えるようにします。
また、pyOpenSciにとって、将来新しいメンテナーの参加を支援する必要がある場合に備えて、メンテナンスのワークフローを文書化しておくことも重要です。
注釈
リポジトリによく考えられた継続的インテグレーションのセットアップがあれば、ユーザーはローカルでのパッケージのビルドを省略することができる（特にテキストを更新するだけの場合）。
Tip
開発ガイドは強く推奨されますが、pyOpenSciがレビューの対象とするためにパッケージに要求するファイルではありません。メンテナによっては、コントリビューティングガイドに開発情報を含めることもできます。