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

この記事のこのバージョンは、GitHub Web サイト上でリポジトリのカスタム命令を使うためのものです。 他の環境でカスタム指示を使う方法については、上のタブをクリックします。

現在、リポジトリのカスタム指示は以下でサポートされています。

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

Prerequisites for repository custom instructions

• You must have a custom instructions file (see the instructions below).

• カスタム指示を使うかどうかという個人の選択肢は、有効に設定する必要があります。 この機能は、既定では有効になっています。 この記事で後述する「リポジトリのカスタム命令の有効化または無効化」を参照してください。

GitHub.com で使用できるように、何種類かのリポジトリ カスタム指示を作成できます。

• リポジトリ全体のカスタム指示は、リポジトリのコンテキストで行われたすべてのリクエストに適用されます。

  サポートしているもの: Copilot Chat、Copilot コーディング エージェント、Copilot コード レビュー。

  これらは、リポジトリの .github ディレクトリ内の copilot-instructions.md ファイルで指定されます。 「リポジトリ全体のカスタム指示の作成」を参照してください。

• パス固有のカスタム指示は、指定したパスに一致するファイルのコンテキストで行われたリクエストに適用されます。

  サポートしているもの: Copilot コーディング エージェント、Copilot コード レビュー。

  これらは、リポジトリの .github/instructions ディレクトリ内の 1 つ以上の NAME.instructions.md ファイルで指定されます。 「パス固有のカスタム指示の作成」を参照してください。

  指定したパスが Copilot による処理対象であるファイルと一致し、リポジトリ全体のカスタム指示ファイルも存在する場合は、両方のファイルの指示が使われます。

• エージェントの指示は AI エージェントによって使われます。

  サポートしているもの: Copilot コーディング エージェント。

  1 つ以上の AGENTS.md ファイルを作成し、リポジトリ内の任意の場所に格納できます。 Copilot が動作している場合は、ディレクトリ ツリー内の最も近い AGENTS.md ファイルが優先されます。

  または、リポジトリのルートに格納された 1 つの CLAUDE.md または GEMINI.md ファイルを使うこともできます。

リポジトリ全体のカスタム指示の作成

独自のカスタム指示ファイルをゼロから作成することもできます。 「独自の copilot-instructions.md ファイルの作成」を参照してください。 または、Copilot コーディング エージェント に生成を依頼することもできます。

Copilot コーディング エージェント への copilot-instructions.md ファイルの生成依頼

1. github.com/copilot/agents の [Agents] ページに移動します。

   このページには、GitHub 上の任意のページの検索バーの横にある ボタンをクリックし、サイドバーから [Agents] を選んでアクセスすることもできます。

2. プロンプト フィールドのドロップダウン メニューを使用して、Copilot にカスタム指示の生成を依頼するリポジトリを選びます。

3. 次のプロンプトをコピーし、必要に応じてカスタマイズします。

   Markdown

   Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently.
   
   You will do this task only one time per repository and doing a good job can SIGNIFICANTLY improve the quality of the agent's work, so take your time, think carefully, and search thoroughly before writing the instructions.
   
   <Goals>
   - Reduce the likelihood of a coding agent pull request getting rejected by the user due to
   generating code that fails the continuous integration build, fails a validation pipeline, or
   having misbehavior.
   - Minimize bash command and build failures.
   - Allow the agent to complete its task more quickly by minimizing the need for exploration using grep, find, str_replace_editor, and code search tools.
   </Goals>
   
   <Limitations>
   - Instructions must be no longer than 2 pages.
   - Instructions must not be task specific.
   </Limitations>
   
   <WhatToAdd>
   
   Add the following high level details about the codebase to reduce the amount of searching the agent has to do to understand the codebase each time:
   <HighLevelDetails>
   
   - A summary of what the repository does.
   - High level repository information, such as the size of the repo, the type of the project, the languages, frameworks, or target runtimes in use.
   </HighLevelDetails>
   
   Add information about how to build and validate changes so the agent does not need to search and find it each time.
   <BuildInstructions>
   
   - For each of bootstrap, build, test, run, lint, and any other scripted step, document the sequence of steps to take to run it successfully as well as the versions of any runtime or build tools used.
   - Each command should be validated by running it to ensure that it works correctly as well as any preconditions and postconditions.
   - Try cleaning the repo and environment and running commands in different orders and document errors and and misbehavior observed as well as any steps used to mitigate the problem.
   - Run the tests and document the order of steps required to run the tests.
   - Make a change to the codebase. Document any unexpected build issues as well as the workarounds.
   - Document environment setup steps that seem optional but that you have validated are actually required.
   - Document the time required for commands that failed due to timing out.
   - When you find a sequence of commands that work for a particular purpose, document them in detail.
   - Use language to indicate when something should always be done. For example: "always run npm install before building".
   - Record any validation steps from documentation.
   </BuildInstructions>
   
   List key facts about the layout and architecture of the codebase to help the agent find where to make changes with minimal searching.
   <ProjectLayout>
   
   - A description of the major architectural elements of the project, including the relative paths to the main project files, the location
   of configuration files for linting, compilation, testing, and preferences.
   - A description of the checks run prior to check in, including any GitHub workflows, continuous integration builds, or other validation pipelines.
   - Document the steps so that the agent can replicate these itself.
   - Any explicit validation steps that the agent can consider to have further confidence in its changes.
   - Dependencies that aren't obvious from the layout or file structure.
   - Finally, fill in any remaining space with detailed lists of the following, in order of priority: the list of files in the repo root, the
   contents of the README, the contents of any key source files, the list of files in the next level down of directories, giving priority to the more structurally important and snippets of code from key source files, such as the one containing the main method.
   </ProjectLayout>
   </WhatToAdd>
   
   <StepsToFollow>
   - Perform a comprehensive inventory of the codebase. Search for and view:
   - README.md, CONTRIBUTING.md, and all other documentation files.
   - Search the codebase for build steps and indications of workarounds like 'HACK', 'TODO', etc.
   - All scripts, particularly those pertaining to build and repo or environment setup.
   - All build and actions pipelines.
   - All project files.
   - All configuration and linting files.
   - For each file:
   - think: are the contents or the existence of the file information that the coding agent will need to implement, build, test, validate, or demo a code change?
   - If yes:
      - Document the command or information in detail.
      - Explicitly indicate which commands work and which do not and the order in which commands should be run.
      - Document any errors encountered as well as the steps taken to workaround them.
   - Document any other steps or information that the agent can use to reduce time spent exploring or trying and failing to run bash commands.
   - Finally, explicitly instruct the agent to trust the instructions and only perform a search if the information in the instructions is incomplete or found to be in error.
   </StepsToFollow>
      - Document any errors encountered as well as the steps taken to work-around them.
   
   

4. Click Send now or press Return.

Copilot will start a new session, which will appear in the list below the prompt box. Copilot will create a draft pull request, write your custom instructions, push them to the branch, then add you as a reviewer when it has finished, triggering a notification.

Writing your own copilot-instructions.md file

1. In the root of your repository, create a file named .github/copilot-instructions.md.

   Create the .github directory if it does not already exist.

2. Add natural language instructions to the file, in Markdown format.

   Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility.

Creating path-specific custom instructions

1. Create the .github/instructions directory if it does not already exist.

2. Create one or more NAME.instructions.md files, where NAME indicates the purpose of the instructions. The file name must end with .instructions.md.

3. At the start of the file, create a frontmatter block containing the applyTo keyword. Use glob syntax to specify what files or directories the instructions apply to.

   For example:

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

   You can specify multiple patterns by separating them with commas. For example, to apply the instructions to all TypeScript files in the repository, you could use the following frontmatter block:

   ---
   applyTo: "**/*.ts,**/*.tsx"
   ---
   

   To apply the instructions to all files, use applyTo: "**".

4. Add your custom instructions in natural language, using Markdown format. Whitespace between instructions is ignored, so the instructions can be written as a single paragraph, each on a new line, or separated by blank lines for legibility.

Copilot Chat のイマーシブ ビュー (github.com/copilot) では、指示ファイルを含むリポジトリをアタッチメントとして追加して、リポジトリ カスタム指示を使う会話を開始できます。

リポジトリ カスタム指示が Copilot Chat で使われるたびに、生成される応答に対する参照として指示ファイルが追加されます。 リポジトリ カスタム指示が使われたかどうかを確認するには、[Chat] パネルのチャット応答の上部にある参照一覧を展開し、.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] オプションをオンまたはオフに切り替えます。