GitHub Copilot コード レビューのコーディング ガイドラインの構成

カスタム コーディング ガイドラインで Copilot コード レビュー をカスタマイズする方法について説明します。

この記事の内容

メモ

カスタム コーディング ガイドライン機能は、Copilot Enterprise プランでのみ利用でき、現在は一部のお客様に限定されています。

この機能は廃止され、今後は Copilot カスタム指示を使った Copilot コード レビュー のカスタマイズが推奨されます。「GitHub Copilot のリポジトリ カスタム命令を追加する」を参照してください。

コーディング ガイドラインについて

Copilot には、自然言語で記述された一連のコーディング ガイドラインを指定できます。これは、organization のコーディング スタイルとベスト プラクティスに合わせてコードをレビューするのに役立ちます。 コーディング ガイドラインの例を含む詳細については、「GitHub Copilot コード レビューのコーディング ガイドラインについて」を参照してください。

コーディング ガイドラインの作成

  1. GitHub で、リポジトリのメイン ページに移動します。

  2. リポジトリ名の下にある [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [設定] をクリックします。

    タブを示すリポジトリ ヘッダーのスクリーンショット。 [設定] タブが濃いオレンジ色の枠線で強調表示されています。

  3. サイドバーの [Code & automation] セクションで、 [Copilot]、[Code review] の順にクリックします。

  4. [Create guideline] をクリックします。

  5. [Name] で、コーディング ガイドラインの名前を指定します。

  6. [Description] で、コーディング ガイドラインの説明を最大 600 文字で指定します。 これは、Copilot がコーディング スタイルを理解し、コメントを残すべきときを判断するために使われます。

    説明の書き方は、Copilot が生成するコメントの品質に大きな影響を与えます。 効果的なコーディング ガイドラインの記述に関するヘルプについては、「GitHub Copilot コード レビューのコーディング ガイドラインについて」を参照してください。

  7. 必要に応じて、[Add file path] をクリックしてパスのパターンを追加し、特定のファイルの種類またはパスにコーディング ガイドラインを制限します。

    fnmatch 構文を使い、任意の文字列に一致するワイルドカードとして * を使って、ターゲットのパスを定義できます。

    GitHub では File::FNM_PATHNAME フラグを File.fnmatch 構文で使うため、* のワイルドカードがディレクトリの区切り記号 (/) と照合されません。 たとえば、qa/* は、qa/ で始まり、1 つのスラッシュを含むすべてのブランチと照合されますが、qa/foo/bar とは照合されません。 qa の後には、qa/**/* を使用して任意の数のスラッシュを含めることができます。これは、たとえば qa/foo/bar/foobar/hello-world と一致します。 qa**/**/* を使い qa の文字列を拡張して、より包括的にすることもできます。

    構文のオプションについて詳しくは、fnmatch のドキュメントを参照してください。

  8. コーディング ガイドラインをテストして、期待どおりに動作することを確認します。

    1. [Add sample] をクリックします。
    2. 独自のサンプルを追加します。または、 [Generate code sample] をクリックし、タイトルと説明に基づいてコード サンプルを自動的に生成します。
    3. [Save] をクリックして、コード サンプルを保存します。
    4. [Run] をクリックし、サンプルに対してコーディング ガイドラインをテストします。

  9. [Save guideline] をクリックし、コーディング ガイドラインを保存して有効にします。