Submitting Pull Requests

Submitting Pull Requests#

pgAdminの機能またはバグ修正を開発する前に、常にメーリングリストpgadmin-hackers@postgresql.orgの開発者に連絡して、計画について話し合う必要があります。これにより、他の人があなたがやっていることを知り、あなたの作業の重複を避けることができ、大規模な変更の場合、コミュニティは、後でリジェクトされる可能性のあるコードの作成に多大な時間を投資する前に、アイデアを議論および調整する機会を与えられます。

リリースtarballではなく、GITソースコードリポジトリからのソースコードのチェックアウトに対して変更を開発する必要があります。これにより、ブランチ上の最新のコードで作業していることが保証され、プルリクエストを正しく生成することが簡単になります。

2022年9月の時点で、pgAdminソースリポジトリはhttps://github.com/pgadmin-org/pgadmin4で見つけることができます。比較的単純な変更の一般的なワークフローは次のとおりです。

  1. GitHubでpgAdmin 4プロジェクトにアクセスし、 Fork ボタンをクリックしてGitHubアカウントに独自の開発リポジトリを作成します。

  2. 次のようなコマンドを使用して、ソースコードのローカルコピーをチェックアウトします。

$ git clone https://github.com/<your GitHub username>/pgadmin4.git
  1. ローカル開発環境で変更を開発およびテストします。

  2. 変更を確認し、徹底的にチェックしてpgAdmin Coding Standards を満たしていることを確認し、 Coding Standards に対してレビューして、拒否される可能性を最小限に抑えます。

  3. 変更に満足したら、適切なメッセージを使用してコミットします。上部に1行の概要を含め、必要に応じて、概要の後の空白行にさらに段落を含めます。

  4. 変更をリポジトリのフォークにプッシュします。

  5. GitHubに戻り、 pgadmin-org/pgadmin4 master ブランチに対して新しいプル要求を作成します。

    注釈

    各プル要求には、単一のバグ修正または機能を単一のコミットとして含める必要があります。必要に応じて、送信する前に、大規模な変更または機能の複数のコミットを単一のコミットに圧縮する必要があります。

  6. あなたのプルリクエストは、開発チームの1人以上のメンバーによって確認され、受け入れられるか、要求された変更とともに返送されます。場合によっては、変更が適切でないと考えられる場合、拒否される場合があります。これが、作業に多大な時間を費やす前にチームと話し合うことが重要である理由です。

より複雑な変更の場合、pgAdminリポジトリのフォークで フィーチャーブランチ を使用し、それを使用してプルリクエストを作成することができます。

注釈

これは、ワークフローの簡単な例です。代わりに GitHub CLI などの他のツールを使用することもできます。ただし、このようなツールやワークフローの文書化は、pgAdminドキュメントの範囲外です。