GitHub Copilot 用のプロンプト ファイル

タスク固有の指示とコンテキストを、個々の Copilot 操作用の再利用可能な Markdown プロンプト ファイルに保存します。

この記事で

プロンプト ファイルは、フォーカスされた Copilot やり取りのための再利用可能なスタンドアロン Markdown テンプレートです。 入力変数と追加のコンテキストを含めることができるため、さまざまな入力でプロンプトを再利用できます。 リポジトリプロンプトファイルは .prompt.md 拡張子を使用し、通常は .github/prompts/に格納されます。 Visual Studio Code と JetBrains IDEs では、別の場所を設定することもできます。

定義されたスコープ内でコンテキストを自動的に提供するカスタム命令とは異なり、プロンプト ファイルは特定のやり取りのために呼び出されます。 サポートされている IDE では、チャットからそれを参照または選択して実行できます。

IDE/バージョンごとのプロンプト ファイルのサポート

プロンプト ファイルは、Visual Studio Code、Visual Studio、JetBrains IDEs、および Xcode で利用できます。 現在のサポートと IDE およびバージョン固有の可用性については、 Copilot カスタマイズのチートシート と Copilot機能マトリックス を参照してください。

Examples

React フォームを生成する

次の New React form.prompt.md ファイルは、React フォームを生成するための再利用可能なタスクを定義します。

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

REST API のセキュリティを確認する

次の API security review.prompt.md ファイルには、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
…