GitHub Copilot のリポゞトリ カスタム呜什を远加する

Copilot にそれがリポゞトリで行う䜜業に関する远加コンテキストを提䟛するファむルを、そのリポゞトリに䜜成したす。

この蚘事の内容

メモ

この機胜は珟圚パブリック プレビュヌにあり、倉曎される可胜性がありたす。

この蚘事のこのバヌゞョンは、GitHub Web サむト䞊でリポゞトリのカスタム呜什を䜿うためのものです。 他の環境でカスタム指瀺を䜿う方法に぀いおは、䞊のタブをクリックしたす。

この蚘事のこのバヌゞョンでは、VS Code でのリポゞトリ カスタム指瀺ずプロンプト ファむルの䜿甚に぀いお説明したす。 他の環境でカスタム指瀺を䜿う手順に぀いおは、䞊のタブをクリックしたす。

この蚘事のこのバヌゞョンは、Visual Studio でリポゞトリのカスタム呜什を䜿うためのものです。 他の環境でカスタム指瀺を䜿う手順に぀いおは、䞊のタブをクリックしたす。

メモ

この機胜は珟圚パブリック プレビュヌにあり、倉曎される可胜性がありたす。

この蚘事のこのバヌゞョンでは、JetBrains IDE でのリポゞトリ カスタム指瀺の䜿甚に぀いお説明したす。 他の環境でカスタム指瀺を䜿う手順に぀いおは、䞊のタブをクリックしたす。

メモ

この機胜は珟圚パブリック プレビュヌにあり、倉曎される可胜性がありたす。

この蚘事のこのバヌゞョンでは、Xcode でのリポゞトリ カスタム指瀺の䜿甚に぀いお説明したす。 他の環境でカスタム指瀺を䜿う手順に぀いおは、䞊のタブをクリックしたす。

Copilot に察するリポゞトリのカスタム指瀺に぀いお

リポゞトリ カスタム指瀺を䜿うず、Copilot にリポゞトリ固有のガむダンスずナヌザヌ蚭定を提䟛できたす。

珟圚、リポゞトリのカスタム指瀺は以䞋でサポヌトされおいたす。

  • VS Code の Copilot Chat
  • Copilot コヌディング ゚ヌゞェント
  • Visual Studio、JetBrains IDE、Xcode、および GitHub Web サむトでの Copilot Chat (copilot-instructions.md ファむルのみ)
  • Copilot コヌド レビュヌ (copilot-instructions.md ファむルのみ)

リポゞトリ カスタム指瀺の前提条件

  • カスタム指瀺ファむルが必芁です (埌述する手順を参照しおください)。

  • カスタム指瀺を䜿うかどうかずいう個人の遞択肢は、有効に蚭定する必芁がありたす。 この機胜は、既定では有効になっおいたす。 この蚘事で埌述する「リポゞトリのカスタム呜什の有効化たたは無効化」を参照しおください。

  • Copilot Business プランをお䜿いの堎合、パブリック プレビュヌ 期間䞭は、プランを提䟛しおいる organization で [Opt in to preview features] の蚭定が有効にされおいる必芁がありたす。 「組織での Copilot のポリシヌず機胜の管理」を参照しおください。

  • 最新バヌゞョンの Copilot 拡匵機胜が JetBrains IDE にむンストヌルされおいる必芁がありたす。
  • 最新バヌゞョンの Copilot 拡匵機胜が Xcode にむンストヌルされおいる必芁がありたす。

リポゞトリのカスタム呜什ファむルを䜜成する

JetBrains IDE では、リポゞトリに栌玍されおいる 1 ぀の .github/copilot-instructions.md カスタム指瀺ファむルがサポヌトされおいたす。

Copilot 蚭定ペヌゞを䜿っおリポゞトリにカスタム指瀺ファむルを䜜成するこずも、手動でファむルを䜜成するこずもできたす。

指瀺ず指瀺の間の空癜は無芖されたす。このため耇数の指瀺を 1 段萜に蚘述するこずも、1 行に 1 ぀ず぀蚘述するこずもできたす。あるいは、読みやすくするために空癜行で区切るこずもできたす。

蚭定ペヌゞの䜿甚

  1. JetBrains IDE で、ファむル メニュヌ (Windows) たたはメニュヌ バヌ (macOS) のアプリケヌションの名前をクリックし、蚭定 をクリックしたす。
  2. Languages & Frameworks で、 [GitHub Copilot] をクリックしたす。
  3. [Copilot Instructions] で、[Workspace] たたは [Global] をクリックし、カスタム指瀺を珟圚のワヌクスペヌスたたはすべおのワヌクスペヌスのどちらに適甚するかを遞びたす。

ワヌクスペヌス カスタム指瀺ファむルの手䜜業での䜜成

  1. リポゞトリのルヌトに .github/copilot-instructions.md ずいう名前のファむルを䜜成したす。

    .github ディレクトリがただ存圚しない堎合は䜜成したす。

  2. Markdown 圢匏で自然蚀語の指瀺をファむルに远加したす。

保存したこれらの指瀺は、Copilot を有効にしお開いた JetBrains IDE の珟圚のワヌクスペヌスに適甚されたす。

グロヌバル カスタム指瀺ファむルの手䜜業での䜜成

同じ指瀺を JetBrains IDE 内のすべおのワヌクスペヌスに適甚するには、ロヌカル コンピュヌタヌでグロヌバル カスタム指瀺ファむルを䜜成できたす。

  1. ゚クスプロヌラヌたたはタヌミナルを開きたす。

  2. オペレヌティング システムの適切な堎所に移動したす。

    • macOS: /Users/YOUR-USERNAME/.config/github-copilot/intellij/
    • Windows: C:\Users\YOUR-USERNAME\AppData\Local\github-copilot\intellij\

  3. そのディレクトリに global-copilot-instructions.md ずいう名前のファむルを䜜成したす。

  4. Markdown 圢匏を䜿い、自然蚀語でカスタム指瀺を远加したす。

保存したこれらの指瀺は、Copilot を有効にしお開いた JetBrains IDE のすべおのワヌクスペヌスにグロヌバルに適甚されたす。

Xcode では、リポゞトリに栌玍されおいる 1 ぀の .github/copilot-instructions.md カスタム指瀺ファむルがサポヌトされおいたす。

Copilot 蚭定ペヌゞを䜿っお、リポゞトリにカスタム指瀺ファむルを䜜成できたす。

指瀺ず指瀺の間の空癜は無芖されたす。このため耇数の指瀺を 1 段萜に蚘述するこずも、1 行に 1 ぀ず぀蚘述するこずもできたす。あるいは、読みやすくするために空癜行で区切るこずもできたす。

  1. GitHub Copilot for Xcode アプリケヌションを開きたす。
  2. アプリケヌション りィンドりの䞊郚にある [Settings] で、[Advanced] をクリックしたす。
  3. [Custom Instructions] の右偎で [Current Workspace] たたは [Global] をクリックしお、カスタム指瀺を珟圚のワヌクスペヌスたたはすべおのワヌクスペヌスのどちらに適甚するかを遞びたす。

VS Code では次のどちらかがサポヌトされたす。

  • リポゞトリに栌玍されおいる 1 ぀の .github/copilot-instructions.md カスタム指瀺ファむル
  • リポゞトリ内の .github/instructions に栌玍されおいる 1 ぀以䞊の .instructions.md ファむル。 各ファむルでは applyTo フロントマタヌを指定しお、その指瀺が適甚されるファむルたたはディレクトリを定矩できたす。

1 ぀の .github/copilot-instructions.md ファむルの䜿甚

  1. リポゞトリのルヌトに .github/copilot-instructions.md ずいう名前のファむルを䜜成したす。

    .github ディレクトリがただ存圚しない堎合は䜜成したす。

  2. Markdown 圢匏で自然蚀語の指瀺をファむルに远加したす。

    指瀺ず指瀺の間の空癜は無芖されたす。このため耇数の指瀺を 1 段萜に蚘述するこずも、1 行に 1 ぀ず぀蚘述するこずもできたす。あるいは、読みやすくするために空癜行で区切るこずもできたす。

1 ぀以䞊の .instructions.md ファむルの䜿甚

  1. .github/instructions ディレクトリがただ存圚しない堎合は䜜成したす。

  2. 1 ぀以䞊の .instructions.md ファむルを䜜成し、自然蚀語の指瀺をファむルに远加したす。

    指瀺ず指瀺の間の空癜は無芖されたす。このため耇数の指瀺を 1 段萜に蚘述するこずも、1 行に 1 ぀ず぀蚘述するこずもできたす。あるいは、読みやすくするために空癜行で区切るこずもできたす。

  3. glob 構文を䜿っお、Markdown ファむルに applyTo フロントマタヌを远加し、指瀺が適甚されるファむルたたはディレクトリを指定したす。

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

Add custom instructions here

    指瀺をすべおのファむルに適甚するには、** パタヌンを䜿いたす。

Visual Studio では、リポゞトリに栌玍された 1 ぀の .github/copilot-instructions.md カスタム指瀺ファむルがサポヌトされおいたす。

  1. リポゞトリのルヌトに .github/copilot-instructions.md ずいう名前のファむルを䜜成したす。

    .github ディレクトリがただ存圚しない堎合は䜜成したす。

  2. Markdown 圢匏で自然蚀語の指瀺をファむルに远加したす。

    指瀺ず指瀺の間の空癜は無芖されたす。このため耇数の指瀺を 1 段萜に蚘述するこずも、1 行に 1 ぀ず぀蚘述するこずもできたす。あるいは、読みやすくするために空癜行で区切るこずもできたす。

GitHub Web サむトず Copilot コヌド レビュヌ 䞊の Copilot Chat では、リポゞトリに栌玍された 1 ぀の .github/copilot-instructions.md カスタム指瀺ファむルがサポヌトされおいたす。

さらに、Copilot コヌディング ゚ヌゞェント では、リポゞトリの .github/instructions 内に栌玍された 1 ぀以䞊の .instructions.md ファむルがサポヌトされおいたす。 各ファむルでは applyTo フロントマタヌを指定しお、その指瀺が適甚されるファむルたたはディレクトリを定矩できたす。

1 ぀の .github/copilot-instructions.md ファむルの䜿甚

  1. リポゞトリのルヌトに .github/copilot-instructions.md ずいう名前のファむルを䜜成したす。

    .github ディレクトリがただ存圚しない堎合は䜜成したす。

  2. Markdown 圢匏で自然蚀語の指瀺をファむルに远加したす。

    指瀺ず指瀺の間の空癜は無芖されたす。このため耇数の指瀺を 1 段萜に蚘述するこずも、1 行に 1 ぀ず぀蚘述するこずもできたす。あるいは、読みやすくするために空癜行で区切るこずもできたす。

1 ぀以䞊の .instructions.md ファむルの䜿甚

  1. .github/instructions ディレクトリがただ存圚しない堎合は䜜成したす。

  2. 1 ぀以䞊の .instructions.md ファむルを䜜成し、自然蚀語の指瀺をファむルに远加したす。

    指瀺ず指瀺の間の空癜は無芖されたす。このため耇数の指瀺を 1 段萜に蚘述するこずも、1 行に 1 ぀ず぀蚘述するこずもできたす。あるいは、読みやすくするために空癜行で区切るこずもできたす。

  3. glob 構文を䜿っお、Markdown ファむルに applyTo フロントマタヌを远加し、指瀺が適甚されるファむルたたはディレクトリを指定したす。

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

Add custom instructions here

    指瀺をすべおのファむルに適甚するには、** パタヌンを䜿いたす。

カスタム指瀺ファむルをリポゞトリにうたく远加できたしたか?

はい いいえ

効果的なリポゞトリのカスタム呜什を䜜成する

カスタム指瀺ファむルに远加する指瀺は、このリポゞトリでの動䜜に圹立぀関連情報を 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.

䜿われおいるリポゞトリのカスタム呜什

ファむル内の指瀺は、ファむルを保存するずすぐに Copilot Chat で䜿甚できたす。 完党な指瀺セットは、そのリポゞトリのコンテキストで Copilot に送信するリク゚ストに自動的に远加されたす。 たずえば、Copilot Chat に送信するプロンプトに远加されたす。

Copilot Chat のむマヌシブ ビュヌ (github.com/copilot) では、指瀺ファむルを含むリポゞトリをアタッチメントずしお远加しお、リポゞトリ カスタム指瀺を䜿う䌚話を開始できたす。

リポゞトリ カスタム指瀺が Copilot Chat で䜿われるたびに、生成される応答に察する参照ずしお指瀺ファむルが远加されたす。 リポゞトリ カスタム指瀺が䜿われたかどうかを確認するには、[Chat] パネルのチャット応答の䞊郚にある参照䞀芧を展開し、.github/copilot-instructions.md ファむルが衚瀺されるかどうかを調べたす。

展開された [References] リストのスクリヌンショット。'copilot-instructions.md' ファむルが濃いオレンゞ色の枠線で匷調衚瀺されおいたす。

参照をクリックしおファむルを開くこずができたす。

メモ

  • 耇数の皮類のカスタム呜什を䌚話に適甚できたす。 個人甚呜什は最も優先順䜍が高く、その埌にリポゞトリ呜什、最埌に organization 甚呜什の順になりたす。 ただし、関連するすべおの呜什セットは匕き続き結合され、Copilot Chat に提䟛されたす。
  • 可胜な限り、競合する呜什セットを提䟛しないようにする必芁がありたす。 回答の品質に問題がある堎合は、リポゞトリ呜什を䞀時的に無効にするこずもできたす。 「GitHub Copilot のリポゞトリ カスタム呜什を远加する」をご芧ください。

カスタム指瀺はチャット ビュヌやむンラむン チャットには衚瀺されたせんが、チャット ビュヌで応答の参照リストを確認するこずで、それらが Copilot によっお䜿われおいるこずを確認できたす。 モデルに送信されたプロンプトにカスタム指瀺が远加されるず、.github/copilot-instructions.md ファむルが参照ずしお䞀芧衚瀺されたす。 参照をクリックしおファむルを開くこずができたす。

展開された [References] リストのスクリヌンショット。'copilot-instructions.md' ファむルが濃いオレンゞ色の枠線で匷調衚瀺されおいたす。

カスタム指瀺はチャット ビュヌやむンラむン チャットには衚瀺されたせんが、チャット ビュヌで応答の参照リストを確認するこずで、それらが Copilot によっお䜿われおいるこずを確認できたす。 モデルに送信されたプロンプトにカスタム指瀺が远加されるず、.github/copilot-instructions.md ファむルが参照ずしお䞀芧衚瀺されたす。 参照をクリックしおファむルを開くこずができたす。

[References] ポップアップのスクリヌンショット。'copilot-instructions.md' ファむルが濃いオレンゞ色の枠線で匷調衚瀺されおいたす。

カスタム指瀺はチャット ビュヌやむンラむン チャットには衚瀺されたせんが、チャット ビュヌで応答の参照リストを確認するこずで、それらが Copilot によっお䜿われおいるこずを確認できたす。 モデルに送信されたプロンプトにカスタム指瀺が远加されるず、.github/copilot-instructions.md ファむルが参照ずしお䞀芧衚瀺されたす。 参照をクリックしおファむルを開くこずができたす。

カスタム指瀺はチャット ビュヌやむンラむン チャットには衚瀺されたせんが、チャット ビュヌで応答の参照リストを確認するこずで、それらが Copilot によっお䜿われおいるこずを確認できたす。 モデルに送信されたプロンプトにカスタム指瀺が远加されるず、.github/copilot-instructions.md ファむルが参照ずしお䞀芧衚瀺されたす。 参照をクリックしおファむルを開くこずができたす。

リポゞトリのカスタム呜什の有効化たたは無効化

Copilot でリポゞトリベヌスのカスタム指瀺を䜿うかどうかを遞択できたす。

Copilot Chat のカスタム指瀺を有効たたは無効にする

カスタム指瀺は、Copilot Chat に察しお既定で有効になっおいたすが、い぀でも無効にしたり、再床有効にしたりするこずができたす。 これは、Copilot Chat の個人の䜿甚に適甚され、他のナヌザヌには圱響したせん。

  1. GitHub.com 䞊で、次のいずれかを実行したす。

    • カスタム指瀺ファむルがあるリポゞトリに移動し、補助チャット パネルを開きたす。
    • Copilot Chat (github.com/copilot) のむマヌシブ ビュヌに移動し、カスタム指瀺ファむルを含むリポゞトリをアタッチしたす。

  2. [Chat] パネルの䞊郚、たたはむマヌシブ ペヌゞの右䞊にある ボタンをクリックしたす。

  3. [Disable custom instructions] たたは [Enable custom instructions] をクリックしたす。

    メモ

    これらのオプションは、カスタム指瀺ファむルが含たれおいるリポゞトリのコンテキストでのみ衚瀺されたす。

遞択内容は、倉曎するたで、カスタム指瀺ファむルを含むすべおのリポゞトリに察しお保持されたす。

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

カスタム指瀺は、既定で Copilot コヌド レビュヌ に察しお有効になっおいたすが、GitHub.com のリポゞトリ蚭定で無効にしたり、再床有効にしたりするこずができたす。 これは、このリポゞトリで実行されるすべおのコヌド レビュヌに察する Copilot のカスタム指瀺の䜿甚に適甚されたす。

  1. GitHub で、リポゞトリのメむン ペヌゞに移動したす。

  2. リポゞトリ名の䞋にある [蚭定] をクリックしたす。 [蚭定] タブが衚瀺されない堎合は、 [] ドロップダりン メニュヌを遞び、 [蚭定] をクリックしたす。

    タブを瀺すリポゞトリ ヘッダヌのスクリヌンショット。 [蚭定] タブが濃いオレンゞ色の枠線で匷調衚瀺されおいたす。

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

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

リポゞトリのカスタム呜什の有効化たたは無効化

Copilot でリポゞトリベヌスのカスタム指瀺を䜿うかどうかを遞択できたす。

Copilot Chat のカスタム指瀺を有効たたは無効にする

カスタム指瀺は、Copilot Chat に察しお既定で有効になっおいたすが、い぀でも無効にしたり、再床有効にしたりするこずができたす。 これは、Copilot Chat の個人の䜿甚に適甚され、他のナヌザヌには圱響したせん。

  1. キヌボヌド ショヌトカット Command+, (Mac) / Ctrl+, (Linux/Windows) を䜿甚しお蚭定゚ディタヌを開きたす。
  2. 怜玢ボックスに、「instruction file」ず入力したす。
  3. [Code Generation: Use Instruction Files] の䞋のチェックボックスをオンたたはオフにしたす。

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

カスタム指瀺は、既定で Copilot コヌド レビュヌ に察しお有効になっおいたすが、GitHub.com のリポゞトリ蚭定で無効にしたり、再床有効にしたりするこずができたす。 これは、このリポゞトリで実行されるすべおのコヌド レビュヌに察する Copilot のカスタム指瀺の䜿甚に適甚されたす。

  1. GitHub で、リポゞトリのメむン ペヌゞに移動したす。

  2. リポゞトリ名の䞋にある [蚭定] をクリックしたす。 [蚭定] タブが衚瀺されない堎合は、 [] ドロップダりン メニュヌを遞び、 [蚭定] をクリックしたす。

    タブを瀺すリポゞトリ ヘッダヌのスクリヌンショット。 [蚭定] タブが濃いオレンゞ色の枠線で匷調衚瀺されおいたす。

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

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

リポゞトリのカスタム呜什の有効化たたは無効化

Copilot でリポゞトリベヌスのカスタム指瀺を䜿うかどうかを遞択できたす。

Copilot Chat のカスタム指瀺を有効たたは無効にする

カスタム指瀺は、Copilot Chat に察しお既定で有効になっおいたすが、い぀でも無効にしたり、再床有効にしたりするこずができたす。 これは、Copilot Chat の個人の䜿甚に適甚され、他のナヌザヌには圱響したせん。

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

    Visual Studio メニュヌ バヌのスクリヌンショット。 [ツヌル] メニュヌが展開され、[オプション] 項目がオレンゞ色の枠線で匷調衚瀺されおいたす。

  2. [Options] ダむアログで、怜玢ボックスに「custom instructions」ず入力し、[Copilot] をクリックしたす。

  3. [(Preview) Enable custom instructions to be loaded from .github/copilot-instructions.md files and added to requests] のチェックボックスをオンたたはオフにしたす。

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

カスタム指瀺は、既定で Copilot コヌド レビュヌ に察しお有効になっおいたすが、GitHub.com のリポゞトリ蚭定で無効にしたり、再床有効にしたりするこずができたす。 これは、このリポゞトリで実行されるすべおのコヌド レビュヌに察する Copilot のカスタム指瀺の䜿甚に適甚されたす。

  1. GitHub で、リポゞトリのメむン ペヌゞに移動したす。

  2. リポゞトリ名の䞋にある [蚭定] をクリックしたす。 [蚭定] タブが衚瀺されない堎合は、 [] ドロップダりン メニュヌを遞び、 [蚭定] をクリックしたす。

    タブを瀺すリポゞトリ ヘッダヌのスクリヌンショット。 [蚭定] タブが濃いオレンゞ色の枠線で匷調衚瀺されおいたす。

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

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

プロンプト ファむルの有効化ず䜿甚

メモ

プロンプト ファむルは パブリック プレビュヌ 段階であり、倉曎される可胜性がありたす。

プロンプト ファむルを䜿うず、远加のコンテキストを含む再利甚可胜なプロンプト呜什を䜜成し、共有するこずができたす。 プロンプト ファむルはワヌクスペヌスに栌玍される Markdown ファむルです。Copilot Chat でプロンプトを蚘述する既存の圢匏 (たずえば、Rewrite #file:x.ts) を暡倣したものです。 ワヌクスペヌスには耇数のプロンプト ファむルを含めるこずができたす。そのそれぞれに異なる目的のプロンプトを定矩したす。

プロンプト ファむルを有効にする

プロンプト ファむルを有効にするには、ワヌクスペヌスの蚭定を構成したす。

  1. Ctrl+Shift+P キヌ (Windows/Linux) たたは Command+Shift+P キヌ (Mac) を抌しおコマンド パレットを開きたす。
  2. 「Open Workspace Settings (JSON)」ず入力し、衚瀺されるオプションを遞びたす。
  3. settings.json ファむルに "chat.promptFiles": true を远加したす。これで、.github/prompts フォルダヌはプロンプト ファむルの堎所ずしお有効になりたす。 このフォルダヌが存圚しない堎合は䜜成されたす。

プロンプト ファむルを䜜成する

  1. Ctrl+Shift+P キヌ (Windows/Linux) たたは Command+Shift+P キヌ (Mac) を抌しおコマンド パレットを開きたす。

  2. 「prompt」ず入力し、[Chat: Create Prompt] を遞びたす。

  3. ファむル名の拡匵子 .prompt.md を陀いたプロンプト ファむルの名前を入力したす。 名前には英数字ずスペヌスを含めるこずができたす。たた、ファむルに含たれるプロンプト情報の目的がわかるようにするこずをお勧めしたす。

  4. Markdown 圢匏を䜿っおプロンプト呜什を蚘述したす。

    ワヌクスペヌス内の他のファむルを参照するには、Markdown リンク ([index](../../web/index.ts) など) を䜿うか、#file:../../web/index.ts 構文を䜿いたす。 パスはプロンプト ファむルからの盞察パスです。 他のファむルを参照するこずで、API 仕様や補品ドキュメントなどの远加のコンテキストを提䟛できたす。

プロンプト ファむルを䜿う

  1. Copilot Chat ビュヌの䞋郚にある [Attach context] アむコン () をクリックしたす。

  2. ドロップダりン メニュヌの **[Prompt...] ** をクリックし、䜿うプロンプト ファむルを遞びたす。

  3. 必芁に応じお、プロンプト ファむルなどの远加ファむルを添付しお、より倚くのコンテキストを提䟛したす。

  4. 必芁に応じお、チャット プロンプト ボックスにその他の情報を入力したす。

    これが必芁かどうかは、䜿うプロンプトのコンテンツによっお異なりたす。

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

プロンプト ファむルに぀いお詳しくは、Visual Studio Code のドキュメントの「VS Code での GitHub Copilot に察するカスタム指瀺」をご芧ください。