メモ
この記事のこのバージョンでは、 GitHub Web サイトでのカスタム手順について説明します。 他の環境については上のタブをクリックしてください。
Copilot応答のカスタマイズについて
GitHub Copilot では、個人の好み、チームの作業方法、使用するツール、またはプロジェクトの詳細に合わせて調整された応答を提供できます(これを行うのに十分なコンテキストを提供する場合)。 このコンテキストの詳細をプロンプトに繰り返し追加する代わりに、この情報を自動的に追加するカスタム命令を作成できます。 追加情報は表示されませんが、 Copilot して、より高品質な応答を生成できます。
メモ
AI の非決定論的な性質により、Copilot は、使用されるたびにまったく同じ方法でカスタム命令に従うとは限りません。
カスタム指示の種類
Copilot Web サイトでGitHub応答をカスタマイズするために使用できるカスタム命令には、主に次の 3 種類があります。
* ** 個人の指示** は、Copilot チャット Web サイト全体のGitHubに関するすべての会話に適用されます。 好みの言語や回答スタイルなどの個別の設定を指定できるため、自分のニーズに合わせた回答を確実に受け取ることができます。 * ** リポジトリのカスタム命令は** 、特定のリポジトリのコンテキスト内の会話に適用されます。 これらは、project固有のコーディング標準、フレームワーク、またはツールを定義するのに役立ちます。 たとえば、リポジトリで TypeScript と特定のライブラリを使うように指定し、すべての共同作成者に対して一貫性のある回答を確保できます。 * ** 組織のカスタム手順は** 、 GitHub Web サイト上の組織のコンテキスト内の会話に適用されます。 共通言語やセキュリティ ガイドラインなど、organization 全体の設定を適用するのに最適です。 組織のカスタム指示は、 Copilot 事業 または Copilot Enterprise サブスクリプションを持つ組織の組織所有者のみが設定できます。
個人の指示について
メモ
個人のカスタム命令は、GitHub の中の GitHub Copilot Chat でのみサポートされます。
個人の指示を追加することで、Copilot チャットでのGitHub.comの応答方法をカスタマイズできます。これは、Copilotのみが適用されます。 これは、Copilot チャットの [GitHub.com] ページのポップアップで行います。 「GitHub Copilot の個人用カスタム命令の追加」を参照してください。
リポジトリのカスタム指示について
CopilotのGitHub.comでは、次の 3 種類のリポジトリ カスタム命令を使用できます。
* リポジトリ全体のカスタム指示。リポジトリのコンテキストで行われたすべてのリクエストに適用されます。
これらは、リポジトリの copilot-instructions.md ディレクトリ内の .github ファイルで指定されます。
-
**パス固有のカスタム指示**。指定したパスに一致するファイルのコンテキストで行われたリクエストに適用されます。これらは、リポジトリ内の
NAME.instructions.mdディレクトリ内または下にある 1 つ以上の.github/instructionsファイルで指定されます。パス固有の指示を使うと、特定の種類のファイルまたは特定のディレクトリにのみ適用される情報でリポジトリ全体の指示がオーバーロードされるのを回避できます。
-
**エージェント命令**は、リポジトリ全体のカスタム命令に似ていますが、現在のところ、Copilot のすべての機能ではサポートされていません。これらは、
AGENTS.md、CLAUDE.md、またはGEMINI.mdと呼ばれるファイルで指定されます。
さまざまな Copilot 機能で利用可能なリポジトリカスタム命令タイプのサポートに関する詳細は、さまざまな種類のカスタム命令のサポート をご覧ください。
サンプルのキュレーション コレクションについては、 カスタム指示 を参照してください。
組織のカスタム手順について
メモ
**サポート:** 現在、組織のカスタム手順は、Copilot チャットでのGitHub.com、Copilotコード レビューでのGitHub.com、Copilot クラウド エージェントでのGitHub.comに対してのみサポートされています。
組織の所有者は、 Copilotの手順を追加して、組織のニーズと好みに合わせて応答を調整できます。 たとえば、会社の選択した言語で、または特定のスタイルで常に Copilot 応答するように選択できます。
組織の Copilot 設定で定義されているカスタム命令は、その組織から Copilot サブスクリプションを受け取るかどうかに関係なく、組織のすべてのメンバーに対して使用されます。
追加できる命令の例を次に示します。
Always respond in Spanish.Do not generate code blocks in responses.For questions related to security, use the Security Docs Knowledge Base.
カスタム命令の優先順位
Copilot に送信された要求には、複数の種類のカスタム命令を適用できます。 個人の指示が最も優先されます。 リポジトリの指示が次に来ると、組織の指示が最後に優先されます。 ただし、関連するすべての指示は、Copilot に提供されます。
次の一覧は、優先順位の完全な順序を示しています。この一覧の上位の手順は、一覧の下位の命令よりも優先されます。
-
**個人的な**指示 -
* 特定のパスに該当する**リポジトリの** カスタム手順:.github/instructions/**/*.instructions.mdファイル内の手順 * Repository-wide.github/copilot-instructions.mdファイルの手順 * エージェント の指示 (たとえば、AGENTS.mdファイル内) -
**組織用カスタムインストラクション**
可能な限り、競合する一組の命令を提供しないようにしてください。 応答の品質が気になる場合は、リポジトリの指示を一時的に無効にすることができます。 「GitHub Copilot用のリポジトリカスタム命令の追加」をご覧ください。
カスタム指示の使用
カスタム指示は自然言語の指示で構成された、短い自己完結型の文章である場合に最も効果的です。 個人レベル、リポジトリレベル、または組織レベルに命令を追加するかどうかを選択するときに、命令を適用するスコープを検討してください。
カスタム指示の種類ごとに、一般的なユース ケースと例を次に示します。 * 個人の指示:
- 優先する個別の言語:
Always respond in Portuguese. - 個別の回答のユーザー設定:
Explain a single concept per line. Be clear and concise. -
**リポジトリのカスタム指示:**- コーディング標準:
Use early returns whenever possible. - フレームワーク:
Use Vue with the PrimeVue library.またはUse Typescript rather than Javascript. - コードのスタイル設定:
Use camel case for variable names.
- コーディング標準:
-
**Organization のカスタム指示:**- 特定の質問に答える方法について説明します:
For questions related to security, use the Security Docs Knowledge Base or advise people to consult with #security on Slack. - 1 つの言語のみを使う会社の優先する言語:
Always respond in Portuguese. - Organization 全体の設定:
Do not generate code blocks in responses.
- 特定の質問に答える方法について説明します:
メモ
- Copilotコード レビュー は、カスタム命令ファイルの最初の 4,000 文字のみを読み取ります。 この制限を超える命令は、Copilotコード レビュー によって生成されるレビューには影響しません。 この制限は、Copilot チャット または Copilot クラウド エージェント には適用されません。
- プルリクエストを確認する場合、Copilot は、プルリクエストのベースブランチにあるカスタム命令を使用します。 たとえば、pull request が
my-feature-branchをmainにマージしようとすると、Copilot はmainのカスタム命令を使用します。
効果的なカスタム指示の記述
カスタム指示ファイルに追加する指示は、このリポジトリでの動作に役立つ関連情報を Copilot に提供する、短い自己完結型の文章にする必要があります。 指示はすべてのチャット メッセージと共に送信されるため、リポジトリのコンテキストで行うほとんどの要求に幅広く適用できるものである必要があります。
指示ファイルに使う正確な構造は、プロジェクトとニーズによって異なりますが、次のガイドラインがよい出発点となります。
- 目的、目標、関連する背景情報など、作業中のプロジェクトの概要を提供します。
- プロジェクトに関連する重要なディレクトリやファイルなど、リポジトリのフォルダー構造を含めます。
- 名前付け規則、書式設定規則、ベスト プラクティスなど、従う必要があるコーディング標準と規則を指定します。
- プロジェクトで使われる特定のツール、ライブラリ、またはフレームワークを、関連するバージョン番号または構成と共に含めます。
次の命令ファイルは、これらの操作の例です。
# Project Overview
This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.
## Folder Structure
- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.
## Libraries and Frameworks
- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.
## Coding Standards
- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.
## UI guidelines
- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.
リポジトリのサイズと複雑さも考慮する必要があります。 次のような指示は、共同作成者が少数の小規模なリポジトリではうまくいく可能性がありますが、大規模で多様なリポジトリでは、問題が発生する可能性があります。
- 応答を作成するときに外部リソースを参照するという要求
- 特定のスタイルで回答するという指示
- 常に特定の詳細レベルで応答するという要求
たとえば、次の指示では意図した結果が得られない場合があります。
Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.
Use @terminal when answering questions about Git.
Answer all questions in the style of a friendly colleague, using informal language.
Answer all questions in less than 1000 characters, and words of no more than 12 characters.
次のステップ
-
[AUTOTITLE](/copilot/customizing-copilot/adding-personal-custom-instructions-for-github-copilot) -
[AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -
[AUTOTITLE](/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot)
詳細については、次を参照してください。
-
[AUTOTITLE](/copilot/concepts/agents/copilot-memory) -
[AUTOTITLE](/copilot/reference/customization-cheat-sheet)
メモ
この記事のこのバージョンでは、 VS Codeのカスタム命令とプロンプト ファイルについて説明します。 他の環境については上のタブをクリックしてください。
Copilot応答のカスタマイズについて
GitHub Copilot では、チームの動作方法、使用するツール、またはプロジェクトの詳細に合わせて調整された応答を提供できます。これを行うのに十分なコンテキストを提供する場合。 このコンテキストの詳細をプロンプトに繰り返し追加する代わりに、この情報を自動的に追加するファイルをリポジトリに作成できます。
Copilotにコンテキストと手順を提供するためにVS Codeで使用できるファイルには、次の2種類があります。
*
リポジトリのカスタム命令 を使用すると、リポジトリのコンテキストで作業するときに考慮 Copilot 命令と基本設定を指定できます。
*
プロンプト ファイル (パブリック プレビュー) を使うと、共通のプロンプト指示と関連するコンテキストを Markdown ファイル (*.prompt.md) に保存し、後でそれをチャット プロンプトで再利用できます。 プロンプト ファイルは、VS Code、Visual Studio、および JetBrains IDE でのみ使用できます。
カスタム指示は、各 AI ワークフローにコードベース全体のコンテキストを追加するのに役立ちますが、プロンプト ファイルを使うと、特定のチャット操作に指示を追加できます。
メモ
AI の非決定論的な性質により、Copilot は、使用されるたびにまったく同じ方法でカスタム命令に従うとは限りません。
リポジトリのカスタム指示について
VS Codeでは、次の 3 種類のリポジトリ カスタム命令を使用できます。
* リポジトリ全体のカスタム指示。リポジトリのコンテキストで行われたすべてのリクエストに適用されます。
これらは、リポジトリの copilot-instructions.md ディレクトリ内の .github ファイルで指定されます。
-
**パス固有のカスタム指示**。指定したパスに一致するファイルのコンテキストで行われたリクエストに適用されます。これらは、リポジトリ内の
NAME.instructions.mdディレクトリ内または下にある 1 つ以上の.github/instructionsファイルで指定されます。パス固有の指示を使うと、特定の種類のファイルまたは特定のディレクトリにのみ適用される情報でリポジトリ全体の指示がオーバーロードされるのを回避できます。
-
**エージェント命令**は、リポジトリ全体のカスタム命令に似ていますが、現在のところ、Copilot のすべての機能ではサポートされていません。これらは、
AGENTS.md、CLAUDE.md、またはGEMINI.mdと呼ばれるファイルで指定されます。
さまざまな Copilot 機能で利用可能なリポジトリカスタム命令タイプのサポートに関する詳細は、さまざまな種類のカスタム命令のサポート をご覧ください。
サンプルのキュレーション コレクションについては、 カスタム指示 を参照してください。
プロンプト ファイルについて
メモ
プロンプト ファイルは パブリック プレビュー され、変更される可能性があります。
プロンプト ファイルを使うと、追加のコンテキストを含む再利用可能なプロンプト命令を作成し、共有することができます。 プロンプト ファイルは、ワークスペースに格納されている Markdown ファイルであり、 Copilot チャット でプロンプトを書き込む既存の形式 (たとえば、 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 …
プロンプト ファイルを有効、作成、および使用する方法については、 GitHub Copilot用のリポジトリカスタム命令の追加 を参照してください。
効果的なカスタム指示の記述
カスタム指示ファイルに追加する指示は、このリポジトリでの動作に役立つ関連情報を Copilot に提供する、短い自己完結型の文章にする必要があります。 指示はすべてのチャット メッセージと共に送信されるため、リポジトリのコンテキストで行うほとんどの要求に幅広く適用できるものである必要があります。
指示ファイルに使う正確な構造は、プロジェクトとニーズによって異なりますが、次のガイドラインがよい出発点となります。
- 目的、目標、関連する背景情報など、作業中のプロジェクトの概要を提供します。
- プロジェクトに関連する重要なディレクトリやファイルなど、リポジトリのフォルダー構造を含めます。
- 名前付け規則、書式設定規則、ベスト プラクティスなど、従う必要があるコーディング標準と規則を指定します。
- プロジェクトで使われる特定のツール、ライブラリ、またはフレームワークを、関連するバージョン番号または構成と共に含めます。
次の命令ファイルは、これらの操作の例です。
# Project Overview
This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.
## Folder Structure
- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.
## Libraries and Frameworks
- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.
## Coding Standards
- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.
## UI guidelines
- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.
リポジトリのサイズと複雑さも考慮する必要があります。 次のような指示は、共同作成者が少数の小規模なリポジトリではうまくいく可能性がありますが、大規模で多様なリポジトリでは、問題が発生する可能性があります。
- 応答を作成するときに外部リソースを参照するという要求
- 特定のスタイルで回答するという指示
- 常に特定の詳細レベルで応答するという要求
たとえば、次の指示では意図した結果が得られない場合があります。
Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.
Use @terminal when answering questions about Git.
Answer all questions in the style of a friendly colleague, using informal language.
Answer all questions in less than 1000 characters, and words of no more than 12 characters.
次のステップ
-
[AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -
[AUTOTITLE](/copilot/tutorials/use-custom-instructions) -
[AUTOTITLE](/copilot/reference/customization-cheat-sheet)
メモ
この記事のこのバージョンでは、 Visual Studioのカスタム命令とプロンプト ファイルについて説明します。 他の環境については上のタブをクリックしてください。
Copilot応答のカスタマイズについて
GitHub Copilot では、チームの動作方法、使用するツール、またはプロジェクトの詳細に合わせて調整された応答を提供できます。これを行うのに十分なコンテキストを提供する場合。 このコンテキストの詳細をプロンプトに繰り返し追加する代わりに、この情報を自動的に追加するファイルをリポジトリに作成できます。
Copilot内のVisual Studioでコンテキストと指示を提供するために使用できるファイルには、2種類あります。
*
リポジトリのカスタム命令 を使用すると、リポジトリのコンテキストで作業するときに考慮 Copilot 命令と基本設定を指定できます。
*
プロンプト ファイル を使用すると、Markdown ファイル (*.prompt.md) に一般的なプロンプトの指示と関連コンテキストを保存し、チャット プロンプトで再利用できます。 プロンプト ファイルは、VS Code、Visual Studio、および JetBrains IDE でのみ使用できます。
カスタム指示は、各 AI ワークフローにコードベース全体のコンテキストを追加するのに役立ちますが、プロンプト ファイルを使うと、特定のチャット操作に指示を追加できます。
メモ
AI の非決定論的な性質により、Copilot は、使用されるたびにまったく同じ方法でカスタム命令に従うとは限りません。
リポジトリのカスタム指示について
Visual Studioでは、次の 2 種類のリポジトリ カスタム命令を使用できます。
* リポジトリ全体のカスタム指示。リポジトリのコンテキストで行われたすべてのリクエストに適用されます。
これらは、リポジトリの copilot-instructions.md ディレクトリ内の .github ファイルで指定されます。
-
**パス固有のカスタム指示**。指定したパスに一致するファイルのコンテキストで行われたリクエストに適用されます。これらは、リポジトリ内の
NAME.instructions.mdディレクトリ内または下の 1 つ以上の.github/instructionsファイルで指定されます。パス固有の指示を使うと、特定の種類のファイルまたは特定のディレクトリにのみ適用される情報でリポジトリ全体の指示がオーバーロードされるのを回避できます。
さまざまな Copilot 機能にわたるこれらの種類のリポジトリ カスタム命令のサポートの詳細については、 さまざまな種類のカスタム命令のサポート を参照してください。
サンプルのキュレーション コレクションについては、 カスタム指示 を参照してください。
プロンプト ファイルについて
プロンプト ファイルを使うと、追加のコンテキストを含む再利用可能なプロンプト命令を作成し、共有することができます。 プロンプト ファイルは、ワークスペースに格納されている Markdown ファイルであり、 Copilot チャット でプロンプトを書き込む既存の形式 (たとえば、 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 …
プロンプト ファイルを作成して使用する方法については、 GitHub Copilot用のリポジトリカスタム命令の追加 を参照してください。
効果的なカスタム指示の記述
カスタム指示ファイルに追加する指示は、このリポジトリでの動作に役立つ関連情報を Copilot に提供する、短い自己完結型の文章にする必要があります。 指示はすべてのチャット メッセージと共に送信されるため、リポジトリのコンテキストで行うほとんどの要求に幅広く適用できるものである必要があります。
指示ファイルに使う正確な構造は、プロジェクトとニーズによって異なりますが、次のガイドラインがよい出発点となります。
- 目的、目標、関連する背景情報など、作業中のプロジェクトの概要を提供します。
- プロジェクトに関連する重要なディレクトリやファイルなど、リポジトリのフォルダー構造を含めます。
- 名前付け規則、書式設定規則、ベスト プラクティスなど、従う必要があるコーディング標準と規則を指定します。
- プロジェクトで使われる特定のツール、ライブラリ、またはフレームワークを、関連するバージョン番号または構成と共に含めます。
次の命令ファイルは、これらの操作の例です。
# Project Overview
This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.
## Folder Structure
- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.
## Libraries and Frameworks
- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.
## Coding Standards
- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.
## UI guidelines
- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.
リポジトリのサイズと複雑さも考慮する必要があります。 次のような指示は、共同作成者が少数の小規模なリポジトリではうまくいく可能性がありますが、大規模で多様なリポジトリでは、問題が発生する可能性があります。
- 応答を作成するときに外部リソースを参照するという要求
- 特定のスタイルで回答するという指示
- 常に特定の詳細レベルで応答するという要求
たとえば、次の指示では意図した結果が得られない場合があります。
Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.
Use @terminal when answering questions about Git.
Answer all questions in the style of a friendly colleague, using informal language.
Answer all questions in less than 1000 characters, and words of no more than 12 characters.
次のステップ
-
[AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -
[AUTOTITLE](/copilot/reference/customization-cheat-sheet)
メモ
この記事のこのバージョンでは、JetBrains IDE のカスタム命令とプロンプト ファイルについて説明します。 他の環境については上のタブをクリックしてください。
Copilot応答のカスタマイズについて
GitHub Copilot では、チームの動作方法、使用するツール、またはプロジェクトの詳細に合わせて調整された応答を提供できます。これを行うのに十分なコンテキストを提供する場合。 このコンテキストの詳細をプロンプトに繰り返し追加する代わりに、この情報を自動的に追加するカスタム命令ファイルをリポジトリに作成できます。
JetBrains IDE で Copilot するコンテキストと手順を提供するために使用できるファイルには、次の 2 種類があります。
-
**リポジトリのカスタム命令** を使用すると、リポジトリのコンテキストで作業するときに考慮 Copilot 命令と基本設定を指定できます。 -
**プロンプト ファイル** (パブリック プレビュー) を使うと、共通のプロンプト指示と関連するコンテキストを Markdown ファイル (`*.prompt.md`) に保存し、後でそれをチャット プロンプトで再利用できます。 プロンプト ファイルは、VS Code、Visual Studio、および JetBrains IDE でのみ使用できます。
カスタム指示は、各 AI ワークフローにコードベース全体のコンテキストを追加するのに役立ちますが、プロンプト ファイルを使うと、特定のチャット操作に指示を追加できます。
メモ
AI の非決定論的な性質により、Copilot は、使用されるたびにまったく同じ方法でカスタム命令に従うとは限りません。
リポジトリのカスタム指示について
JetBrains IDE では、リポジトリのカスタム命令は、リポジトリに作成する 1 つのファイル (.github/copilot-instructions.md) で構成されます。 ファイルに追加する手順は、コンテキストまたは関連情報を追加する短い自己完結型のステートメントで、 Copilot プロンプトを補完する必要があります。
リポジトリのカスタム指示のサポート
さまざまな環境でサポートされているカスタム命令の種類の詳細については、 さまざまな種類のカスタム命令のサポート を参照してください。
カスタム指示のユース ケース
カスタム命令の一般的なユース ケースは次のとおりです。
-
**テスト生成。** 特定のテスト フレームワークの使用を指定するなど、テストの生成に関する指示を作成します。 -
**コード レビュー。** コード内の特定のエラーを探すようにレビュー担当者に指示するなど、コードのレビューに関する指示を指定します。 -
**コミット メッセージの生成。** コミット メッセージを生成する手順 (形式や含める情報の種類など) を記述します。
例
この .github/copilot-instructions.md ファイルの例には、Copilot 向けの 3 つの指示が含まれています。
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 チャット でプロンプトを書き込む既存の形式 (たとえば、 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 …
サンプルのキュレーション コレクションについては、 プロンプトファイル を参照してください。
効果的なカスタム指示の記述
カスタム指示ファイルに追加する指示は、このリポジトリでの動作に役立つ関連情報を Copilot に提供する、短い自己完結型の文章にする必要があります。 指示はすべてのチャット メッセージと共に送信されるため、リポジトリのコンテキストで行うほとんどの要求に幅広く適用できるものである必要があります。
指示ファイルに使う正確な構造は、プロジェクトとニーズによって異なりますが、次のガイドラインがよい出発点となります。
- 目的、目標、関連する背景情報など、作業中のプロジェクトの概要を提供します。
- プロジェクトに関連する重要なディレクトリやファイルなど、リポジトリのフォルダー構造を含めます。
- 名前付け規則、書式設定規則、ベスト プラクティスなど、従う必要があるコーディング標準と規則を指定します。
- プロジェクトで使われる特定のツール、ライブラリ、またはフレームワークを、関連するバージョン番号または構成と共に含めます。
次の命令ファイルは、これらの操作の例です。
# Project Overview
This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.
## Folder Structure
- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.
## Libraries and Frameworks
- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.
## Coding Standards
- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.
## UI guidelines
- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.
リポジトリのサイズと複雑さも考慮する必要があります。 次のような指示は、共同作成者が少数の小規模なリポジトリではうまくいく可能性がありますが、大規模で多様なリポジトリでは、問題が発生する可能性があります。
- 応答を作成するときに外部リソースを参照するという要求
- 特定のスタイルで回答するという指示
- 常に特定の詳細レベルで応答するという要求
たとえば、次の指示では意図した結果が得られない場合があります。
Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.
Use @terminal when answering questions about Git.
Answer all questions in the style of a friendly colleague, using informal language.
Answer all questions in less than 1000 characters, and words of no more than 12 characters.
次のステップ
-
[AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -
[AUTOTITLE](/copilot/tutorials/use-custom-instructions) -
[AUTOTITLE](/copilot/reference/customization-cheat-sheet)
メモ
この記事のこのバージョンでは、Xcode のカスタム指示について説明します。 他の環境については上のタブをクリックしてください。
Copilot応答のカスタマイズについて
GitHub Copilot では、チームの動作方法、使用するツール、またはプロジェクトの詳細に合わせて調整された応答を提供できます。これを行うのに十分なコンテキストを提供する場合。 このコンテキストの詳細をプロンプトに繰り返し追加する代わりに、この情報を自動的に追加するカスタム命令ファイルをリポジトリに作成できます。 追加情報はチャット入力ボックスには表示されませんが、Copilot がより高品質な応答を生成できるように利用されます。
メモ
AI の非決定論的な性質により、Copilot は、使用されるたびにまったく同じ方法でカスタム命令に従うとは限りません。
リポジトリのカスタム指示について
Xcode では、リポジトリのカスタム命令は、リポジトリに作成する 1 つのファイル (.github/copilot-instructions.md) で構成されます。 ファイルに追加する手順は、コンテキストまたは関連情報を追加する短い自己完結型のステートメントで、 Copilot プロンプトを補完する必要があります。
リポジトリのカスタム指示のサポート
さまざまな環境でサポートされているカスタム命令の種類の詳細については、 さまざまな種類のカスタム命令のサポート を参照してください。
カスタム指示のユース ケース
リポジトリのカスタム手順の一般的なユース ケースは次のとおりです。
-
**テスト生成。** 特定のテスト フレームワークの使用を指定するなど、テストの生成に関する指示を作成します。 -
**コード レビュー。** コード内の特定のエラーを探すようにレビュー担当者に指示するなど、コードのレビューに関する指示を指定します。 -
**コミット メッセージの生成。** コミット メッセージを生成する手順 (形式や含める情報の種類など) を記述します。
例
この .github/copilot-instructions.md ファイルの例には、Copilot 向けの 3 つの指示が含まれています。
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.
サンプルのキュレーション コレクションについては、 カスタム指示 を参照してください。
効果的なカスタム指示の記述
カスタム指示ファイルに追加する指示は、このリポジトリでの動作に役立つ関連情報を Copilot に提供する、短い自己完結型の文章にする必要があります。 指示はすべてのチャット メッセージと共に送信されるため、リポジトリのコンテキストで行うほとんどの要求に幅広く適用できるものである必要があります。
指示ファイルに使う正確な構造は、プロジェクトとニーズによって異なりますが、次のガイドラインがよい出発点となります。
- 目的、目標、関連する背景情報など、作業中のプロジェクトの概要を提供します。
- プロジェクトに関連する重要なディレクトリやファイルなど、リポジトリのフォルダー構造を含めます。
- 名前付け規則、書式設定規則、ベスト プラクティスなど、従う必要があるコーディング標準と規則を指定します。
- プロジェクトで使われる特定のツール、ライブラリ、またはフレームワークを、関連するバージョン番号または構成と共に含めます。
次の命令ファイルは、これらの操作の例です。
# Project Overview
This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.
## Folder Structure
- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.
## Libraries and Frameworks
- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.
## Coding Standards
- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.
## UI guidelines
- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.
リポジトリのサイズと複雑さも考慮する必要があります。 次のような指示は、共同作成者が少数の小規模なリポジトリではうまくいく可能性がありますが、大規模で多様なリポジトリでは、問題が発生する可能性があります。
- 応答を作成するときに外部リソースを参照するという要求
- 特定のスタイルで回答するという指示
- 常に特定の詳細レベルで応答するという要求
たとえば、次の指示では意図した結果が得られない場合があります。
Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.
Use @terminal when answering questions about Git.
Answer all questions in the style of a friendly colleague, using informal language.
Answer all questions in less than 1000 characters, and words of no more than 12 characters.
次のステップ
-
[AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -
[AUTOTITLE](/copilot/tutorials/use-custom-instructions) -
[AUTOTITLE](/copilot/reference/customization-cheat-sheet)
メモ
この記事のこのバージョンでは、Eclipse のカスタム指示について説明します。 他の環境については上のタブをクリックしてください。
Copilot応答のカスタマイズについて
GitHub Copilot では、チームの動作方法、使用するツール、またはプロジェクトの詳細に合わせて調整された応答を提供できます。これを行うのに十分なコンテキストを提供する場合。 このコンテキストの詳細をプロンプトに繰り返し追加する代わりに、この情報を自動的に追加するカスタム命令ファイルをリポジトリに作成できます。 追加情報はチャット入力ボックスには表示されませんが、Copilot がより高品質な応答を生成するために利用できます。
Eclipse で Copilot するコンテキストと手順を提供するために使用できるリポジトリカスタム命令には、次の 2 種類があります。
-
**ワークスペース カスタム指示**: ワークスペース内のすべてのプロジェクトに適用され、ワークスペース全体の指示と優先設定を 1 つのファイルで指定できます。 -
**特定のプロジェクトに適用されるカスタム指示**。
メモ
AI の非決定論的な性質により、Copilot は、使用されるたびにまったく同じ方法でカスタム命令に従うとは限りません。
リポジトリのカスタム指示について
**ワークスペース カスタム指示**は、ワークスペース内のすべてのプロジェクトに適用され、ワークスペース全体の指示と優先設定を指定できます。 ワークスペースのカスタムインストラクションを使用して、EclipseでCopilotにコンテキストや指示を提供できます。
**Projectカスタム命令**は、projectで作成する 1 つのファイル (`.github/copilot-instructions.md`) で構成されます。 ファイルに追加する手順は、コンテキストまたは関連情報を追加する短い自己完結型のステートメントで、 Copilot プロンプトを補完する必要があります。
一般的なユース ケースは次のとおりです。
-
**テスト生成。** 特定のテスト フレームワークの使用を指定するなど、テストの生成に関する指示を作成します。 -
**コード レビュー。** コード内の特定のエラーを探すようにレビュー担当者に指示するなど、コードのレビューに関する指示を指定します。 -
**コミット メッセージの生成。** コミット メッセージを生成する手順 (形式や含める情報の種類など) を記述します。
例
この .github/copilot-instructions.md ファイルの例には、Copilot 向けの 3 つの指示が含まれています。
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.
サンプルのキュレーション コレクションについては、 カスタム指示 を参照してください。
効果的なカスタム指示の記述
カスタム指示ファイルに追加する指示は、このリポジトリでの動作に役立つ関連情報を Copilot に提供する、短い自己完結型の文章にする必要があります。 指示はすべてのチャット メッセージと共に送信されるため、リポジトリのコンテキストで行うほとんどの要求に幅広く適用できるものである必要があります。
指示ファイルに使う正確な構造は、プロジェクトとニーズによって異なりますが、次のガイドラインがよい出発点となります。
- 目的、目標、関連する背景情報など、作業中のプロジェクトの概要を提供します。
- プロジェクトに関連する重要なディレクトリやファイルなど、リポジトリのフォルダー構造を含めます。
- 名前付け規則、書式設定規則、ベスト プラクティスなど、従う必要があるコーディング標準と規則を指定します。
- プロジェクトで使われる特定のツール、ライブラリ、またはフレームワークを、関連するバージョン番号または構成と共に含めます。
次の命令ファイルは、これらの操作の例です。
# Project Overview
This project is a web application that allows users to manage their tasks and to-do lists. It is built using React and Node.js, and uses MongoDB for data storage.
## Folder Structure
- `/src`: Contains the source code for the frontend.
- `/server`: Contains the source code for the Node.js backend.
- `/docs`: Contains documentation for the project, including API specifications and user guides.
## Libraries and Frameworks
- React and Tailwind CSS for the frontend.
- Node.js and Express for the backend.
- MongoDB for data storage.
## Coding Standards
- Use semicolons at the end of each statement.
- Use single quotes for strings.
- Use function based components in React.
- Use arrow functions for callbacks.
## UI guidelines
- A toggle is provided to switch between light and dark mode.
- Application should have a modern and clean design.
リポジトリのサイズと複雑さも考慮する必要があります。 次のような指示は、共同作成者が少数の小規模なリポジトリではうまくいく可能性がありますが、大規模で多様なリポジトリでは、問題が発生する可能性があります。
- 応答を作成するときに外部リソースを参照するという要求
- 特定のスタイルで回答するという指示
- 常に特定の詳細レベルで応答するという要求
たとえば、次の指示では意図した結果が得られない場合があります。
Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.
Use @terminal when answering questions about Git.
Answer all questions in the style of a friendly colleague, using informal language.
Answer all questions in less than 1000 characters, and words of no more than 12 characters.
次のステップ
-
[AUTOTITLE](/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot) -
[AUTOTITLE](/copilot/tutorials/use-custom-instructions) -
[AUTOTITLE](/copilot/reference/customization-cheat-sheet)