GitHub Copilot Chat の回答のカスタマイズについて

GitHub Copilot は、チームの活動方法、使用するツール、またはプロジェクトの詳細に合わせて調整されたチャット応答を提供できます (そのために十分なコンテキストを指定した場合)。 このコンテキストの詳細をチャットの質問に繰り返し追加するのではなく、この情報を自動的に追加するファイルをリポジトリ内に作成できます。

VS Code で GitHub Copilot Chat にコンテキストと指示を提供するには、次の 2 種類のファイルを使用できます。

• リポジトリ カスタム指示を使うと、リポジトリのコンテキストで行われる会話に適用されるリポジトリ全体の指示とユーザー設定を、1 つのファイルで指定できます。
• プロンプト ファイル (パブリック プレビュー) を使うと、共通のプロンプト指示と関連するコンテキストを Markdown ファイル (*.prompt.md) に保存し、後でそれをチャット プロンプトで再利用できます。 プロンプト ファイルは、VS Code でのみ使用できます。

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

リポジトリのカスタム指示について

リポジトリのカスタム指示は、リポジトリ内に作成する 1 つのファイル .github/copilot-instructions.md で構成されます。 ファイルに追加する指示は、チャットの質問を補完するコンテキストや関連情報を追加する、短い自己完結型の文章にすることをお勧めします。

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

• テストの生成。 特定のテスト フレームワークの使用を指定するなど、テストの生成に関する指示を作成します。
• コード レビュー。 コード内の特定のエラーを探すようにレビュー担当者に指示するなど、コードのレビューに関する指示を指定します。
• コミット メッセージの生成。 コミット メッセージを生成する手順 (形式や含める情報の種類など) を記述します。

例

This example of a .github/copilot-instructions.md file contains three instructions for Copilot.

We use Bazel for managing our Java dependencies, not Maven, so when talking about Java packages, always give me instructions and code samples that use Bazel.

We always write JavaScript with double quotes and tabs for indentation, so when your responses include JavaScript code, please follow those conventions.

Our team uses Jira for tracking items of work.

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

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

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

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

ワークスペースには複数のプロンプト ファイルを含めることができます。そのそれぞれに異なる目的のプロンプトを定義します。

例

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

• 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
  

• API security review.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
  …
  

We use Bazel for managing our Java dependencies, not Maven, so when talking about Java packages, always give me instructions and code samples that use Bazel.

We always write JavaScript with double quotes and tabs for indentation, so when your responses include JavaScript code, please follow those conventions.

Our team uses Jira for tracking items of work.

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