GitHub Copilot のリポジトリ カスタム命令を追加する

さらに、プロンプト ファイルを作成することもできます。 プロンプト ファイルを使うと、共通のプロンプト命令と関連するコンテキストを Markdown ファイル (*.prompt.md) に指定できます。また、チャット プロンプトでそれを再利用できます。 プロンプト ファイルは、VS Code でのみ使用できます。

• 自分の設定で [Use Instruction Files] オプションを有効にする必要があります。 この機能は、既定では有効になっています。 この記事で後述する「リポジトリのカスタム命令の有効化または無効化」を参照してください。

.github/copilot-instructions.md ファイルの指示は、ファイルを保存するとすぐに Copilot Chat によって使用できます。 完全な指示セットは、Copilot Chat ビューまたはインライン チャットで送信した要求に自動的にアタッチされます。

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

1. キーボード ショートカット Command+, (Mac) / Ctrl+, (Linux/Windows) を使用して設定エディターを開きます。
2. 検索ボックスに、「instruction file」と入力します。
3. [Code Generation: Use Instruction Files] の下のチェックボックスをオンまたはオフにします。

プロンプト ファイルについて

プロンプト ファイルを使うと、追加のコンテキストを含む再利用可能なプロンプト命令を作成し、共有することができます。 プロンプト ファイルは、Copilot Chat でプロンプトを記述する既存の形式を模倣した Markdown ファイルです (たとえば、Rewrite #file:x.ts)。 これにより、自然言語命令、追加のコンテキストだけでなく、依存関係としての他のプロンプト ファイルへのリンクも組み合わせて使用することができます。

カスタム命令は、各 AI ワークフローにコードベース全体のコンテキストを追加するのに役立ちますが、プロンプト ファイルを使うと、特定のチャット操作に命令を追加できます。

一般的な使用用途は次のとおりです。

• コードの生成。 コンポーネント、テスト、または移行 (React フォーム、API モックなど) 用の再利用可能なプロンプトを作成します。
• ドメイン専門知識。 プロンプトを通じて、セキュリティ対策やコンプライアンス チェックなどの専門知識を共有します。
• チーム コラボレーション。 仕様とドキュメントを参照して、パターンとガイドラインを文書化します。
• オンボード。 複雑なプロセスやプロジェクト固有のパターンにはステップバイステップ ガイドを作成します。

プロンプト ファイルの例

次の例は、プロンプト ファイルの使用方法を示しています。

• react-form.prompt.md - フォームを生成するための再利用可能なタスクを文書化します。

  Your goal is to generate a new React form component.
  
  Ask for the form name and fields if not provided.
  
  Requirements for the form:
  - Use form design system components: [design-system/Form.md](../docs/design-system/Form.md)
  - Use `react-hook-form` for form state management:
    - Always define TypeScript types for your form data
    - Prefer *uncontrolled* components using register
    - Use `defaultValues` to prevent unnecessary rerenders
  - Use `yup` for validation:
    - Create reusable validation schemas in separate files
    - Use TypeScript types to ensure type safety
    - Customize UX-friendly validation rules
  

• security-api.prompt.md - REST API のセキュリティ レビューを行うために使用できる、REST API の再使用可能なセキュリティ プラクティスを文書化します。

  Secure REST API review:
  - Ensure all endpoints are protected by authentication and authorization
  - Validate all user inputs and sanitize data
  - Implement rate limiting and throttling
  - Implement logging and monitoring for security events
  …
  

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

プロンプト ファイルを有効にするには、chat.promptFilesVS Code 設定を構成します。 これを true に設定するか、{ "/path/to/folder": boolean } 表記を使って別のパスを指定します。 相対パスはワークスペースのルート フォルダーから解決され、他のパスが指定されない場合は既定値の .github/prompts が使われます。 詳細な手順については、Visual Studio Code ドキュメントの「GitHub Copilot in VS Code の設定リファレンス」を参照してください。

1. ワークスペースの .github/prompts ディレクトリに .prompt.md ファイルを作成します。

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

   追加のワークスペース ファイルを Markdown リンク ([index](../index.ts)) として参照するか、プロンプト ファイル内の #file:../index.ts 参照として参照します。 他の .prompt.md ファイルを参照することもできます。

3. 添付アイコンを選び、**[Prompt...] ** を選び、プロンプト ファイルを選んで、Copilot Chat または Copilot Edits に添付します。

4. 必要に応じて、タスクに必要な追加のコンテキスト ファイルを添付します。

5. チャット プロンプトを送信します。

   • 再利用可能なタスクの場合は、追加の命令なしでプロンプトを送信します。
   • 追加の命令を含めることで、現在のタスクのより詳しいコンテキストを提供できます。