GitHub Copilot を使ったコードレビュー

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

Copilotコード レビュー の使用

これらの手順では、GitHub Web サイトで Copilotコード レビュー を使用する方法について説明します。 他の一般的なコーディング環境での指示を見るには、ページの上部で適切なタブをクリックしてください。

1. GitHub.com で、pull request を作成するか、既存の pull request に移動します。

2.        **[Reviewers]** メニューを開き、**[Copilot]** を選びます。
   

   

3. Copilot が pull request をレビューするまで待ちます。 通常、これにかかる時間は 30 秒未満です。

4. 下にスクロールして、Copilot のコメントを読みます。

   

   Copilot は常に、"承認" レビューや "変更要求" レビューではなく、"コメント" レビューを残します。 つまり、Copilot のレビューは pull request の必須の承認にはカウントされず、Copilot のレビューによって変更のマージが禁止されることはありません。 詳細については、「必須レビューでのプルリクエストの承認」を参照してください。

5. Copilot のレビュー コメントは、人間によるレビュー コメントと同様に動作します。 それにリアクションを追加したり、コメントしたり、それを解決したり、非表示にしたりできます。

   Copilot のレビュー コメントに追加したコメントはユーザーに対しては表示されますが、Copilot には表示されず、Copilot は返信しません。

Copilot によって提案された変更に取り組む

可能であれば、Copilot のフィードバックには、2 回のクリックで適用できる推奨される変更が含まれています。

変更に満足できる場合は、Copilot からの 1 つの提案を受け入れてコミットするか、提案のグループを 1 回のコミットでまとめて受け入れます。 詳しくは、「プルリクエストでのフィードバックを取り込む」をご覧ください。

また、Copilotコーディングエージェント を起動して、推奨される変更を実装することもできます。 これを行うには、次の手順を実行する必要があります。

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

Copilot のレビューに対するフィードバックの提供

Copilot のコメントに対するフィードバックは、各コメント内で直接提供できます。 この情報は、製品と Copilot の提案の品質の向上に使われます。

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

   

2. サムダウン ボタンをクリックした場合は、追加情報の提供を求められます。 必要に応じて、否定的なフィードバックの理由を選び、コメントを残してから、[Submit feedback] をクリックできます。

   

Copilot による再レビューの要求

Copilot がレビューした pull request への変更をプッシュしても、変更の再レビューは自動的には行われません。

Copilot による再レビューを要求するには、[Reviewers] メニューの Copilot の名前の横にある ボタンをクリックします。 詳しくは、「プルリクエストレビューを依頼する」をご覧ください。

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

既定では、人間にレビューを依頼するのと同じ方法で、pull request ごとに Copilot から手動でレビューを依頼します。 ただし、すべての pull request を自動的にレビューするように Copilot を設定することはできます。 「GitHub Copilot による自動コード レビューの構成」を参照してください。

カスタム指示を使用した Copilot のレビューのカスタマイズ

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

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

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

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

例

この例の .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.

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.