GitHub Copilot用のリポジトリカスタム命令の追加

Introduction

リポジトリのカスタム命令を使用すると、リポジトリ固有のガイダンスとCopilotに関する基本設定をGitHubに提供できます。 IDE でカスタム命令を設定する方法については、 IDE での GitHub Copilot のリポジトリカスタム手順の追加を参照してください。カスタム手順の詳細については、「 GitHub Copilotの応答をカスタマイズする方法」を参照してください。

リポジトリカスタム指示の前提条件

カスタム指示ファイルが必要です (後述する手順を参照してください)。
Copilotコードレビューでは、カスタム命令を使用するかどうかの個人的な選択を有効に設定する必要があります。この機能は、既定では有効になっています。この記事の後半で「Enabling or disabling repository custom instructions (リポジトリのカスタム指示の有効化または無効化)」を参照してください。

カスタム指示の作成

          Copilot
          GitHubでは、3 種類のリポジトリカスタム命令がサポートされます。 これらの種類の手順をサポートする GitHub Copilot 機能の詳細については、 [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=webui#support-for-repository-custom-instructions) を参照してください。

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

これらは、リポジトリの copilot-instructions.md ディレクトリ内の .github ファイルで指定されます。「リポジトリ全体のカスタム指示の作成」を参照してください。
パス固有のカスタム指示。指定したパスに一致するファイルのコンテキストで行われたリクエストに適用されます。

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

指定したパスが、 Copilot 作業中のファイルと一致し、リポジトリ全体のカスタム命令ファイルも存在する場合は、両方のファイルの命令が使用されます。
エージェントの指示は AI エージェントによって使われます。

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

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

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

ユーザー独自のカスタム指示ファイルをゼロから作成することもできます。「Writing your own copilot-instructions.md file (独自の copilot-instructions.md ファイルの作成)」を参照してください。または、Copilot クラウドエージェントに生成を頼むことができます。

          Copilot クラウドエージェント ファイルの生成を`copilot-instructions.md`に要求する

1. github.com/copilot/agents の [エージェント] タブに移動します。

このページには、<svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-copilot" aria-label="Copilot icon" role="img"><path d="M7.998 15.035c-4.562 0-7.873-2.914-7.998-3.749V9.338c.085-.628.677-1.686 1.588-2.065.013-.07.024-.143.036-.218.029-.183.06-.384.126-.612-.201-.508-.254-1.084-.254-1.656 0-.87.128-1.769.693-2.484.579-.733 1.494-1.124 2.724-1.261 1.206-.134 2.262.034 2.944.765.05.053.096.108.139.165.044-.057.094-.112.143-.165.682-.731 1.738-.899 2.944-.765 1.23.137 2.145.528 2.724 1.261.566.715.693 1.614.693 2.484 0 .572-.053 1.148-.254 1.656.066.228.098.429.126.612.012.076.024.148.037.218.924.385 1.522 1.471 1.591 2.095v1.872c0 .766-3.351 3.795-8.002 3.795Zm0-1.485c2.28 0 4.584-1.11 5.002-1.433V7.862l-.023-.116c-.49.21-1.075.291-1.727.291-1.146 0-2.059-.327-2.71-.991A3.222 3.222 0 0 1 8 6.303a3.24 3.24 0 0 1-.544.743c-.65.664-1.563.991-2.71.991-.652 0-1.236-.081-1.727-.291l-.023.116v4.255c.419.323 2.722 1.433 5.002 1.433ZM6.762 2.83c-.193-.206-.637-.413-1.682-.297-1.019.113-1.479.404-1.713.7-.247.312-.369.789-.369 1.554 0 .793.129 1.171.308 1.371.162.181.519.379 1.442.379.853 0 1.339-.235 1.638-.54.315-.322.527-.827.617-1.553.117-.935-.037-1.395-.241-1.614Zm4.155-.297c-1.044-.116-1.488.091-1.681.297-.204.219-.359.679-.242 1.614.091.726.303 1.231.618 1.553.299.305.784.54 1.638.54.922 0 1.28-.198 1.442-.379.179-.2.308-.578.308-1.371 0-.765-.123-1.242-.37-1.554-.233-.296-.693-.587-1.713-.7Z"></path><path d="M6.25 9.037a.75.75 0 0 1 .75.75v1.501a.75.75 0 0 1-1.5 0V9.787a.75.75 0 0 1 .75-.75Zm4.25.75v1.501a.75.75 0 0 1-1.5 0V9.787a.75.75 0 0 1 1.5 0Z"></path></svg>の任意のページの検索バーの横にある [****] ボタンをクリックし、サイドバーから GitHub を選択してアクセスすることもできます。

プロンプトフィールドのドロップダウンで、カスタム命令を生成するためのリポジトリを選択します。

次のプロンプトをコピーしてプロンプトフィールドに貼り付け、必要に応じてカスタマイズします。

Markdown

Your task is to "onboard" this repository to Copilot cloud agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a cloud 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 cloud 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>

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 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 cloud 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.

Your task is to "onboard" this repository to Copilot cloud agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a cloud 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 cloud 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 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 cloud 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.

Click or press Enter.

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 finished, triggering a notification.

Writing your own `copilot-instructions.md` file

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

Create the .github directory if it does not already exist.
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.

ヒント

The first time you create a pull request in a given repository with Copilot クラウドエージェント, Copilot will leave a comment with a link to automatically generate custom instructions for the repository.

Creating path-specific custom instructions

メモ

Currently, on GitHub.com, path-specific custom instructions are only supported for Copilot クラウドエージェント and Copilotコードレビュー.

       `.github/instructions` ディレクトリがまだ存在しない場合は作成します。

必要に応じて、 .github/instructions のサブディレクトリを作成して命令ファイルを整理します。
1 つ以上の NAME.instructions.md ファイルを作成します。ここで、NAME は指示の目的を示します。ファイル名は .instructions.md で終わる必要があります。
ファイルの先頭に、applyTo キーワードを含む frontmatter ブロックを作成します。 glob 構文を使用して、指示が適用されるファイルまたはディレクトリを指定します。

次に例を示します。
```
---
applyTo: "app/models/**/*.rb"
---
```
複数のパターンをコンマで区切って指定できます。たとえば、リポジトリ内のすべての TypeScript ファイルに指示を適用するには、次の frontmatter ブロックを使用できます。
```
---
applyTo: "**/*.ts,**/*.tsx"
---
```
Glob の例:
- * - 現在のディレクトリ内のすべてのファイルと一致します。
- ** または **/* - すべてのディレクトリ内のすべてのファイルと一致します。
- *.py - 現在のディレクトリ内のすべての .py ファイルと一致します。
- **/*.py - すべてのディレクトリ内のすべての .py ファイルと再帰的に一致します。
- src/*.py- .py ディレクトリ内のすべてのsrc ファイルと一致します。たとえば、src/foo.pyとsrc/bar.pyしかし_ではない_src/foo/bar.py。
- src/**/*.py- .py ディレクトリ内のすべてのsrc ファイルと再帰的に一致します。たとえば、 src/foo.py、 src/foo/bar.py、 src/foo/bar/baz.pyなどです。
- **/subdir/**/*.py- 任意の.py ディレクトリ内のすべてのsubdir ファイルを任意の深さで再帰的に照合します。たとえば、subdir/foo.py、subdir/nested/bar.py、parent/subdir/baz.py、deep/parent/subdir/nested/qux.py は使用できますが、__ ディレクトリを含まないパスではfoo.py``subdir。
必要に応じて、ファイルが Copilot クラウドエージェントまたは Copilotコードレビューによって使用されないようにするには、frontmatter ブロックに excludeAgent キーワードを追加します。 "code-review"または"cloud-agent"を使用します。

たとえば、次のファイルは Copilot クラウドエージェントによってのみ読み取られます。
```
---
applyTo: "**"
excludeAgent: "code-review"
---
```
```
       `excludeAgent` キーワードが front matterblock に含まれていない場合は、Copilotコード レビューとCopilot クラウドエージェントの両方で指示が使用されます。
```
Markdown 形式を使い、自然言語でカスタム指示を追加します。指示と指示の間の空白は無視されます。このため複数の指示を 1 段落に記述することも、1 行に 1 つずつ記述することもできます。あるいは、読みやすくするために空白行で区切ることもできます。

カスタム指示ファイルをリポジトリにうまく追加できましたか?

          <a href="https://docs.github.io/success-test/yes.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline">
          <span>はい</span></a><a href="https://docs.github.io/success-test/no.html" target="_blank" class="btn btn-outline mt-3 mr-3 no-underline"><span>いいえ</span></a>

使用中のカスタム手順

ファイル内の手順は、ファイルを保存するとすぐに Copilot で使用できます。手順は、 Copilotに送信した要求に自動的に追加されます。

In コパイロットチャット (github.com/copilot), you can start a conversation that uses repository custom instructions by adding, as an attachment, the repository that contains the instructions file.

Whenever repository custom instructions are used by コパイロットチャット, the instructions file is added as a reference for the response that's generated. To find out whether repository custom instructions were used, expand the list of references at the top of a chat response in the Chat panel and check whether the .github/copilot-instructions.md file is listed.

Screenshot of an expanded References list, showing the 'copilot-instructions.md' file highlighted with a dark orange outline.

You can click the reference to open the file.

メモ

Copilot に送信された要求には、複数の種類のカスタム命令を適用できます。個人の指示が最も優先されます。リポジトリの指示が次に来ると、組織の指示が最後に優先されます。ただし、関連するすべての指示は、Copilot に提供されます。
可能な限り、競合する一組の命令を提供しないようにしてください。応答の品質が気になる場合は、リポジトリの指示を一時的に無効にすることができます。「GitHub Copilot用のリポジトリカスタム命令の追加」をご覧ください。

Enabling or disabling custom instructions for Copilotコードレビュー

Custom instructions are enabled for Copilotコードレビュー by default but you can disable, or re-enable, them in the repository settings on GitHub.com. This applies to Copilot's use of custom instructions for all code reviews it performs in this repository.

GitHub で、リポジトリのメインページに移動します。
リポジトリ名の下にある [Settings] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウンメニューを選び、 [設定] をクリックします。
In the "Code & automation" section of the sidebar, click Copilot, then Code review.
Toggle the “Use custom instructions when reviewing pull requests” option on or off.

メモ

プルリクエストを確認する場合、Copilot は、プルリクエストのベースブランチにあるカスタム命令を使用します。たとえば、pull request が my-feature-branch を mainにマージしようとすると、Copilot は mainのカスタム命令を使用します。