GitHub Copilot のコード レビューについて

はじめに

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

Copilot では、任意のプログラミング言語で記述されたコードをレビューできます。

この記事では、Copilot コード レビューの概要について説明します。 Copilot からコード レビューを要求する方法については、「GitHub Copilot コード レビューの使用」を参照してください。

可用性

Copilot コード レビュー は以下でサポートされています。

• GitHub.com
• GitHub Mobile
• VS Code
• Visual Studio
• Xcode

Copilot コード レビューは Premium 機能であり (1 つ例外があります)、Copilot Pro、Copilot Pro+、Copilot Business、Copilot Enterprise プランで使用できます。

例外は、Visual Studio Code のファイル内のコードの選択のレビューです。 これは、VS Code のすべての Copilot ユーザーが使用できる標準機能です。

Organization から Copilot を受け取った場合、GitHub.com または GitHub Mobile で Copilot に pull request のレビューを要求できるようにするには、organization の Copilot ポリシー設定で [Copilot コード レビュー] オプションを有効にする必要があります。 「GitHub Copilot のポリシーと機能を Organization で管理する」を参照してください。

コード レビューの月間クォータ

Copilot を pull request のレビュー担当者として割り当てる場合、または Copilot を要求して IDE でコミットされていないすべての変更をレビューする場合、Copilot Premium リクエストの月間クォータが 1 つ減ります。 Premium リクエストについては、「GitHub Copilot における要求」をご覧ください。

リポジトリがすべての新しい pull request についてコード レビューを Copilot に自動的に要求するように構成されている場合、Premium リクエストの使用量は pull request 作成者のクォータに適用されます。 pull request が GitHub Actions またはボットによって作成された場合、ワークフローをトリガーしたユーザー (特定できる場合)、または指定された課金所有者に使用量が適用されます。

月間クォータに達すると、Copilot プランをアップグレードするか追加の Premium リクエストを有効にしない限り、クォータがリセットされるまで Copilot のコード レビューを受け取ることができません。

Visual Studio Code 内の Copilot コード レビュー

Visual Studio Code の Copilot コード レビュー は、次の 2 種類のレビューをサポートしています。

• 選択内容をレビューする:
  • コードを範囲選択し、最初のレビューを依頼します。
  • 標準 Copilot 機能。 Premium リクエストは使用されません。
  • カスタム指示をサポートしていません。
• 変更内容をレビューする:
  • コミットされていないすべての変更の詳細なレビューを要求します。
  • Premium 機能。 レビューごとに月間クォータから 1 つの Premium リクエストを使用します。
  • カスタム指示をサポートしています。

Copilot コード レビューに対する指示の提供

カスタム指示を指定して、Copilot が生成するレビューを調整できます。 これは、Copilot がチームのコーディング標準、ツール、プラクティスに一致する方法でコードをレビューするのに役立ちます。 「GitHub Copilot のリポジトリ カスタム命令を追加する」と「GitHub Copilot に対する organization カスタム指示の追加」を参照してください。

Copilot コード レビューの検証

Copilot によって、pull request 内のすべての問題または issue が特定されることは保証されず、間違う可能性があります。 常に Copilot のフィードバックを慎重に検証し、Copilot のフィードバックを人間のレビューで補完してください。

詳しくは、「GitHub Copilot コード レビューの責任ある使用」をご覧ください。

自動 pull request レビューについて

Copilot の既定では、人間のレビュー担当者を割り当てる場合と同じ方法で pull request に割り当てられている場合にのみ、pull request がレビューされます。 ただし

• Copilot Pro または Copilot Pro+ プランの個々のユーザーは、自分が作成したすべての pull request を自動的にレビューするように Copilot を構成できます。
• リポジトリ所有者は、Copilot へのアクセス権を持つユーザーによって作成されたリポジトリ内のすべての pull request を自動的にレビューするように Copilot を構成できます。
• Organization 所有者は、Copilot ユーザーによって pull request が作成された organization 内の一部またはすべてのリポジトリにあるすべての pull request を自動的にレビューするように、Copilot を構成できます。

自動 pull request レビューをトリガーする

自動コード レビューのトリガーは構成設定によって異なります。

• 基本設定:
  • Pull request が "オープン" pull request として作成されたとき。
  • "ドラフト" pull request が初めて "オープン" に切り替えられたとき。
• 新しいプッシュをレビューする:
  • 新しいコミットが pull request にプッシュされるたび。
• ドラフトの pull request をレビューする:
  • Pull request は、ドラフト段階で自動的にレビューされ、"オープン" に切り替わる前に実行されます。

自動 pull request レビューの制限

Copilot コード レビュー は、1 人あたりの月間クォータが設定されている Premium 機能です。 Copilot で自動レビューを実行する場合、pull request を作成したユーザーのクォータから 1 つの Premium リクエストが使われます。 詳しくは、「GitHub Copilot コード レビューの使用」をご覧ください。

自動 pull request レビューの構成

新しい pull request を自動的にレビューするように Copilot を構成する方法の詳細については、「Copilot を使って自動コード レビューを構成する」を参照してください。

参考資料

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