Skip to main content

GitHub Copilotコード レビューでのGitHubの使用

GitHub Copilot は pull request をレビューし、すぐに適用できる変更を提案するため、すべてのコミットに対して迅速で実用的なフィードバックを得ることができます。

Copilotコード レビュー は、エンタープライズ管理者または組織の所有者が有効にした場合、 Copilot ライセンスを持たない組織メンバーでも使用できます。 Copilotコード レビュー ライセンスを持たない組織メンバーのCopilotを参照してください。

レビューを要求する Copilot

  1. GitHub.comで、pull request を作成または開きます。

  2. [校閲者] メニューを開き、[Copilot] を選択します。

    [Reviewers] メニューからの Copilot の選択のスクリーンショット。

  3. Copilotの確認が完了するまで待ちます。 通常、これにかかる時間は 30 秒未満です。

  4. pull request に関する Copilotのコメントを読み取ります。

    Copilot が残したコード レビューのスクリーンショット。

Copilot 常に、"承認" または "変更の要求" レビューではなく、"コメント" レビューを残します。 そのレビューは、必要な承認にカウントされず、マージをブロックしません。

Copilotのレビュー コメントは、人間のレビュー担当者からのコメントと同様に機能します。 リアクションの追加、返信、解決、非表示を切り替えます。 追加した返信は他のユーザーには表示されますが、 Copilotには表示されません。

推奨される変更を操作する

Copilotのフィードバックには、多くの場合、数回のクリックで適用できる推奨される変更が含まれています。 1 つの提案を受け入れるか、複数の提案を 1 つのコミットにグループ化します。 詳細については、「プルリクエストでのフィードバックを取り込む」を参照してください。

提案された変更をCopilot クラウドエージェントで直接実装するには:

  1. パブリック プレビューのコードレビューで使用するCopilotのツールを選択し、Copilot クラウドエージェントを有効にします。
  2. GitHub Copilotコード レビューからのレビュー コメントで、[提案の実装] をクリックします。 これにより、特定のフィードバックに対処するように Copilot に指示する下書きコメントが作成されます。 Copilot 次に、提案が適用されたブランチに対して新しいプル要求を作成します。

レビューに関するフィードバックを提供する

Copilotのコメントを評価して、将来の提案を改善します。

  1. Copilotのレビュー コメントで、サムアップ (👍) またはサムダウン (👎) ボタンをクリックします。

    Copilotコード レビュー のコメントとサム アップおよびサム ダウンのボタンを示すスクリーンショット。

  2. 低評価ボタンをクリックした場合は、必要に応じて理由を選択してコメントを残し、フィードバックを送信をクリックします。

    Copilot からのコメントに対して否定的なフィードバックをするときに追加情報を提供するためのフォームのスクリーンショット。

再レビューを要求する

Copilot では、新しい変更をプッシュするときに自動的に再レビューされることはありません。 再レビューを要求するには、[] メニューのCopilotの名前の横にある [****] ボタンをクリックします。

再レビュー中に、Copilot により、コメントを解決したりダウンボートした場合でも、以前のコメントが繰り返されることがあります。

自動レビューを有効にする

既定では、各プル要求で Copilot に手動でレビューを要求します。 すべてのプル要求の自動レビューを有効にするには、 GitHub Copilotによる自動コード レビューの構成 を参照してください。

カスタム手順を使用してレビューをカスタマイズする

リポジトリにカスタム指示を追加して、Copilotコード レビュー をカスタマイズできます。

リポジトリのカスタム指示は、リポジトリ全体を対象にすることも、パス固有にすることもできます。 リポジトリ全体のカスタム指示は、リポジトリ内の .github/copilot-instructions.md ファイルで指定します。 このファイルを使うと、Copilot がリポジトリ内の任意の場所のコードをレビューするときに考慮する情報を格納できます。

また、指定したパスと一致するファイル内のコードをレビューするときにのみ Copilot が使う指示を記述することもできます。 これらの指示は、1 つ以上の .github/instructions/**/*.instructions.md ファイルで記述します。

詳しくは、「GitHub Copilot用のリポジトリカスタム命令の追加」をご覧ください。

メモ

* Copilotコード レビュー は、カスタム命令ファイルの最初の 4,000 文字のみを読み取ります。 この制限を超える手順は、 Copilotコード レビューによって生成されたレビューには影響しません。 この制限は、 コパイロットチャット または Copilot クラウドエージェントには適用されません。

  • プルリクエストを確認する場合、Copilot は、プルリクエストのベースブランチにあるカスタム命令を使用します。 たとえば、pull request が my-feature-branchmainにマージしようとすると、Copilot は mainのカスタム命令を使用します。

この例の .github/copilot-instructions.md ファイルには、リポジトリ内のすべての Copilotコード レビュー に適用される 3 つの指示が含まれています。

When performing a code review, respond in Spanish.

When performing a code review, apply the checks in the `/security/security-checklist.md` file.

When performing a code review, focus on readability and avoid nested ternary operators.

詳細については、次を参照してください。