为 GitHub Copilot 添加存储库自定义说明

本文的此版本适用于在 GitHub 上使用存储库自定义说明。 单击上面的选项卡，获取有关在其他环境中使用自定义说明的信息。

• 关于是否要使用自定义说明的个人选择必须设置为“已启用”。 此项已默认启用。 请参阅本文后面的启用或禁用存储库自定义说明。

GitHub 网站上的 Copilot 对话助手、Copilot 编码智能体 和 Copilot 代码评审 支持存储在存储库中的单个 .github/copilot-instructions.md 自定义说明文件************。

此外，Copilot 编码智能体 支持****：

• 存储在存储库中 .github/instructions 内的一个或多个 .instructions.md 文件。 每个文件都可以指定 applyTo 前辅文，以定义其说明适用的文件或目录。
• 存储在存储库内任意位置的一个或多个 AGENTS.md 文件。 当 Copilot 正常工作时，目录树中最接近的 AGENTS.md 文件将优先。
• 存储在存储库根目录中的单个 CLAUDE.md 或 GEMINI.md 文件。

使用单个 .github/copilot-instructions.md 文件

可以要求 Copilot 编码智能体 生成 .github/copilot-instructions.md 文件，也可以编写自己的说明文件。

要求 Copilot 编码智能体 生成 .github/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 .github/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.

Using one or more .instructions.md files

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

2. Create one or more .instructions.md files, adding natural language instructions to the file(s).

   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.

3. Specify what files or directories the instructions apply to by adding applyTo frontmatter to the Markdown files, using glob syntax.

   ---
   applyTo: "app/models/**/*.rb"
   ---
   
   Add custom instructions here
   

   若要将说明应用于所有文件，请使用 ** 模式。

在 Copilot 对话助手 的沉浸式视图 (github.com/copilot) 中，可以通过附加包含指令文件的存储库来发起使用存储库自定义指令的对话。

每当 Copilot 对话助手 使用存储库自定义指令时，指令文件都将被添加为所生成响应的引用。 要查看是否使用了仓库自定义指令，请展开“Chat”面板中聊天响应顶部的引用列表，检查是否列出了 .github/copilot-instructions.md 文件。

可以单击引用信息来打开该文件。

启用或禁用存储库自定义说明

可以选择是否要让 Copilot 使用基于仓库的自定义指令。

为 Copilot 对话助手 启用或禁用自定义指令

默认情况下，Copilot 对话助手 已启用自定义指令，但你可以随时禁用或重新启用它们。 这适用于你自己的 Copilot 对话助手 使用，不会影响其他用户。

1. 在 GitHub.com 上，执行下列操作之一：

   • 转到使用自定义指令文件的存储库，打开辅助聊天面板。
   • 转到 Copilot 对话助手 (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”选项。