IDE での GitHub Copilot のリポジトリ カスタム手順の追加

この記事のこのバージョンでは、 Visual Studioでリポジトリのカスタム命令とプロンプト ファイルを使用します。 他の環境でカスタム指示を使う手順については、上のタブをクリックします。

イントロダクション

リポジトリ カスタム指示を使うと、Copilot にリポジトリ固有のガイダンスとユーザー設定を提供できます。 詳しくは、「GitHub Copilotの応答をカスタマイズする方法」をご覧ください。

リポジトリ カスタム指示の前提条件

• カスタム指示ファイルが必要です (後述する手順を参照してください)。

• 自分の設定で [Enable custom instructions...] オプションを有効にする必要があります。 この機能は、既定では有効になっています。 この記事の後半で「Enabling or disabling repository custom instructions (リポジトリのカスタム指示の有効化または無効化)」を参照してください。

カスタム指示の作成

Visual Studio では、2 種類のカスタム命令がサポートされています。 これらの種類の手順をサポートする GitHub Copilot 機能の詳細については、 GitHub Copilotの応答をカスタマイズする方法 を参照してください。

• リポジトリ全体のカスタム指示。リポジトリのコンテキストで行われたすべてのリクエストに適用されます。

  これらは、リポジトリの copilot-instructions.md ディレクトリ内の .github ファイルで指定されます。 「リポジトリ全体のカスタム指示の作成」を参照してください。

• パス固有のカスタム指示。指定したパスに一致するファイルのコンテキストで行われたリクエストに適用されます。

  これらは、リポジトリ内の NAME.instructions.md ディレクトリ内または下にある 1 つ以上の.github/instructions ファイルで指定されます。 「Creating path-specific custom instructions (パス固有のカスタム指示の作成)」を参照してください。

  指定したパスが、 Copilot 作業中のファイルと一致し、リポジトリ全体のカスタム命令ファイルも存在する場合は、両方のファイルの命令が使用されます。

リポジトリ全体のカスタム指示の作成

1. リポジトリのルートに .github/copilot-instructions.md という名前のファイルを作成します。

.github ディレクトリがまだ存在しない場合は作成します。

1. Markdown 形式で自然言語の指示をファイルに追加します。

   指示と指示の間の空白は無視されます。このため複数の指示を 1 段落に記述することも、1 行に 1 つずつ記述することもできます。あるいは、読みやすくするために空白行で区切ることもできます。

パス固有のカスタム指示の作成

1. .github/instructions ディレクトリがまだ存在しない場合は作成します。

2. 必要に応じて、 .github/instructions のサブディレクトリを作成して命令ファイルを整理します。

3. 1 つ以上の NAME.instructions.md ファイルを作成します。ここで、NAME は指示の目的を示します。 ファイル名は .instructions.md で終わる必要があります。

4. ファイルの先頭に、applyTo キーワードを含む frontmatter ブロックを作成します。 glob 構文を使用して、指示が適用されるファイルまたはディレクトリを指定します。

   次に例を示します。

   ---
   applyTo: "app/models/**/*.rb"
   ---
   

   複数のパターンをコンマで区切って指定できます。 たとえば、リポジトリ内のすべての TypeScript ファイルに指示を適用するには、次の frontmatter ブロックを使用できます。

   ---
   applyTo: "**/*.ts,**/*.tsx"
   ---
   

   Glob の例:

   • * - 現在のディレクトリ内のすべてのファイルと一致します。
   • ** または **/* - すべてのディレクトリ内のすべてのファイルと一致します。
   • *.py - 現在のディレクトリ内のすべての .py ファイルと一致します。
   • **/*.py - すべてのディレクトリ内のすべての .py ファイルと再帰的に一致します。
   • src/*.py- .py ディレクトリ内のすべてのsrc ファイルと一致します。 たとえば、src/foo.pyとsrc/bar.pyしかし_ではない_src/foo/bar.py。
   • src/**/*.py- .py ディレクトリ内のすべてのsrc ファイルと再帰的に一致します。 たとえば、 src/foo.py、 src/foo/bar.py、 src/foo/bar/baz.pyなどです。
   • **/subdir/**/*.py- 任意の.py ディレクトリ内のすべてのsubdir ファイルを任意の深さで再帰的に照合します。 たとえば、subdir/foo.py、subdir/nested/bar.py、parent/subdir/baz.py、deep/parent/subdir/nested/qux.py は使用できますが、__ ディレクトリを含まないパスではfoo.py``subdir。

5. 必要に応じて、ファイルが Copilot クラウドエージェント または Copilotコード レビューによって使用されないようにするには、frontmatter ブロックに excludeAgent キーワードを追加します。 "code-review"または"cloud-agent"を使用します。

   たとえば、次のファイルは Copilot クラウドエージェントによってのみ読み取られます。

   ---
   applyTo: "**"
   excludeAgent: "code-review"
   ---
   

excludeAgent キーワードが front matterblock に含まれていない場合は、Copilotコード レビューとCopilot クラウドエージェントの両方で指示が使用されます。

1. Markdown 形式を使い、自然言語でカスタム指示を追加します。 指示と指示の間の空白は無視されます。このため複数の指示を 1 段落に記述することも、1 行に 1 つずつ記述することもできます。あるいは、読みやすくするために空白行で区切ることもできます。

使用中のカスタム手順

ファイル内の手順は、ファイルを保存するとすぐに Copilot で使用できます。 手順は、 Copilotに送信した要求に自動的に追加されます。

カスタム指示はチャット ビューやインライン チャットには表示されませんが、チャット ビューで応答の参照リストを確認することで、それらが Copilot によって使われていることを確認できます。 モデルに送信されたプロンプトにカスタム指示が追加されると、.github/copilot-instructions.md ファイルが参照として一覧表示されます。 参照をクリックしてファイルを開くことができます。

リポジトリのカスタム命令の有効化または無効化

Copilot でリポジトリベースのカスタム指示を使うかどうかを選択できます。

コパイロットチャット のカスタム指示を有効または無効にする

カスタム指示は、コパイロットチャット に対して既定で有効になっていますが、いつでも無効にしたり、再度有効にしたりすることができます。 これは、コパイロットチャット の個人の使用に適用され、他のユーザーには影響しません。

1. Visual Studioメニュー バーの [ツール] で、[オプション] をクリックします。

   

2. [オプション] ダイアログボックスで、検索ボックスに「 custom instructions 」と入力し、[ Copilot] をクリックします。

3. .github/copilot-instructions.md ファイルからカスタムインストラクションを読み込み、リクエストに追加する チェックボックスを選択または解除します。

   

Copilotコード レビュー のカスタム指示を有効または無効にする

カスタム指示は、既定で Copilotコード レビュー に対して有効になっていますが、GitHub.com のリポジトリ設定で無効にしたり、再度有効にしたりすることができます。 これは、このリポジトリで実行されるすべてのコード レビューに対する Copilot のカスタム指示の使用に適用されます。

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

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

   

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

4. [Use custom instructions when reviewing pull requests] オプションをオンまたはオフに切り替えます。

プロンプト ファイルを使う

プロンプト ファイルを使うと、追加のコンテキストを含む再利用可能なプロンプト命令を作成し、共有することができます。 プロンプト ファイルは、ワークスペースに格納されている Markdown ファイルであり、 コパイロットチャット でプロンプトを書き込む既存の形式 (たとえば、 Rewrite #file:x.ts) を模倣します。 ワークスペースには複数のプロンプト ファイルを含めることができます。そのそれぞれに異なる目的のプロンプトを定義します。

プロンプト ファイルを作成する

1. リポジトリのルートにある.prompt.md フォルダー内に、.github/prompts ファイル名拡張子を含むプロンプト ファイルを追加します。 名前には英数字とスペースを含めることができます。また、ファイルに含まれるプロンプト情報の目的がわかるようにすることをお勧めします。

2. Markdown 形式を使ってプロンプト命令を記述します。

   ワークスペース内の他のファイルを参照するには、Markdown リンク ([index](../../web/index.ts) など) を使うか、#file:'../../web/index.ts' 構文を使います。 パスはプロンプト ファイルからの相対パスです。 他のファイルを参照することで、API 仕様や製品ドキュメントなどの追加のコンテキストを提供できます。

プロンプト ファイルの詳細については、Visual StudioドキュメントVisual Studio」を参照してください。

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

• さまざまな種類のカスタム命令のサポート
• カスタマイズ ライブラリ - サンプルの厳選されたコレクション
• カスタム命令を使用してCopilotのコードレビュー機能を引き出す