为 GitHub Copilot 添加仓库自定义指令

本文档版本适用于在 GitHub 网站上使用仓库自定义指令。点击上方选项卡可查看在其他环境中自定义指令的信息。

简介

仓库自定义指令允许您为 Copilot 提供仓库特定的指导和偏好。有关更多信息，请参阅关于自定义 GitHub Copilot 响应。

仓库自定义指令的先决条件

• 您必须有一个自定义指令文件（请参阅以下说明）。

• 对于 Copilot 代码审查，您个人选择是否使用自定义指令必须设置为启用。此功能默认启用。请参阅本文档后面的启用或禁用仓库自定义指令。

创建自定义指令

GitHub 上的 Copilot 支持三种类型的仓库自定义指令。有关哪些 GitHub Copilot 功能支持这些类型指令的详细信息，请参阅关于自定义 GitHub Copilot 响应。

• 仓库范围的自定义指令适用于在仓库上下文中发出的所有请求。

  这些指令在仓库的 .github 目录中的 copilot-instructions.md 文件中指定。请参阅创建仓库范围的自定义指令。

• 特定路径的自定义指令适用于在与指定路径匹配的文件上下文中发出的请求。

  这些指令在一个或多个 NAME.instructions.md 文件中指定，这些文件位于仓库的 .github/instructions 目录内或其下方。请参阅创建特定路径的自定义指令。

  如果您指定的路径与 Copilot 正在处理的文件匹配，并且仓库范围的自定义指令文件也存在，那么将同时使用这两个文件中的指令。

• 代理指令由 AI 代理使用。

  您可以创建包含一个或多个 AGENTS.md 文件，存储在仓库的任何位置。当 Copilot 工作时，目录树中最接近的 AGENTS.md 文件将优先。有关更多信息，请参阅 agentsmd/agents.md 仓库。

  或者，您可以使用存储在仓库根目录中的单个 CLAUDE.md 或 GEMINI.md 文件。

创建仓库范围的自定义指令

您可以从头开始创建自己的自定义指令文件。请参阅编写您自己的 copilot-instructions.md 文件。或者，您可以要求 Copilot 云代理为您生成一个。

要求 Copilot 云代理生成一个 copilot-instructions.md 文件

1. 导航到 github.com/copilot/agents 上的代理选项卡。

   您也可以通过点击 GitHub 任何页面上搜索栏旁边的 按钮，然后从侧边栏中选择 Agents（代理）。

2. 使用提示字段中的下拉菜单，选择您希望 Copilot 为其生成自定义指令的仓库。

3. 复制以下提示并将其粘贴到提示字段中，如果需要，请自定义它

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

4. 点击 或按 Enter。

Copilot 将启动一个新会话，该会话将显示在提示框下方的列表中。Copilot 将创建一个草稿拉取请求，编写您的自定义指令，将其推送到分支，然后在完成后将您添加为审查者，从而触发通知。

编写您自己的 copilot-instructions.md 文件

1. 在仓库的根目录中，创建一个名为 .github/copilot-instructions.md 的文件。

   如果 .github 目录尚不存在，请创建它。

2. 以 Markdown 格式向文件中添加自然语言指令。

   指令之间的空白将被忽略，因此指令可以写成单个段落，每条指令在新的一行，或者为了易读性用空行分隔。

创建特定路径的自定义指令

1. 如果 .github/instructions 目录尚不存在，请创建它。

2. 可选地，创建 .github/instructions 的子目录来组织您的指令文件。

3. 创建一个或多个 NAME.instructions.md 文件，其中 NAME 指示指令的目的。文件名必须以 .instructions.md 结尾。

4. 在文件的开头，创建一个包含 applyTo 关键字的 frontmatter 块。使用 glob 语法指定指令应用于哪些文件或目录。

   例如

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

   您可以通过逗号分隔多个模式。例如，要将指令应用于仓库中的所有 TypeScript 文件，可以使用以下 frontmatter 块

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

   Glob 示例

   • * - 将匹配当前目录中的所有文件。
   • ** 或 **/* - 将匹配所有目录中的所有文件。
   • *.py - 将匹配当前目录中的所有 .py 文件。
   • **/*.py - 将递归匹配所有目录中的所有 .py 文件。
   • src/*.py - 将匹配 src 目录中的所有 .py 文件。例如，src/foo.py 和 src/bar.py，但**不**匹配 src/foo/bar.py。
   • src/**/*.py - 将递归匹配 src 目录中的所有 .py 文件。例如，src/foo.py、src/foo/bar.py 和 src/foo/bar/baz.py。
   • **/subdir/**/*.py - 将递归匹配任何深度下的任何 subdir 目录中的所有 .py 文件。例如，subdir/foo.py、subdir/nested/bar.py、parent/subdir/baz.py 和 deep/parent/subdir/nested/qux.py，但**不**匹配不包含 subdir 目录的路径中的 foo.py。

5. 可选地，为了防止文件被 Copilot 云代理或 Copilot 代码审查使用，请在 frontmatter 块中添加 excludeAgent 关键字。使用 "code-review" 或 "cloud-agent"。

   例如，以下文件将仅由 Copilot 云代理读取。

   ---
   applyTo: "**"
   excludeAgent: "code-review"
   ---
   

   如果 frontmatter 块中未包含 excludeAgent 关键字，Copilot 代码审查和 Copilot 云代理都将使用您的指令。

6. 使用 Markdown 格式添加您的自然语言自定义指令。指令之间的空白将被忽略，因此指令可以写成单个段落，每条指令在新的一行，或者为了易读性用空行分隔。

正在使用的自定义指令

文件中的指令在您保存文件后即可供 Copilot 使用。指令会自动添加到您提交给 Copilot 的请求中。

在 Copilot Chat (github.com/copilot) 中，您可以通过将包含指令文件的仓库作为附件添加，来开始使用仓库自定义指令的对话。

每当 Copilot Chat 使用仓库自定义指令时，指令文件都会作为生成响应的参考添加。要查明是否使用了仓库自定义指令，请展开聊天面板中聊天响应顶部的参考列表，并检查是否列出了 .github/copilot-instructions.md 文件。

您可以点击参考打开文件。

为 Copilot 代码审查启用或禁用自定义指令

Copilot 代码审查默认启用自定义指令，但您可以在 GitHub.com 上的仓库设置中禁用或重新启用它们。这适用于 Copilot 在此仓库中执行的所有代码审查对自定义指令的使用。

1. 在 GitHub 上，导航至仓库的主页面。

2. 在仓库名称下方，点击 设置。如果您看不到“设置”选项卡，请选择 下拉菜单，然后点击 设置。

   

3. 在侧边栏的“代码与自动化”部分，点击 Copilot，然后点击 代码审查。

4. 打开或关闭“审查拉取请求时使用自定义指令”选项。

延伸阅读

• 对不同类型自定义指令的支持
• 自定义指令——精选示例集
• 使用自定义指令解锁 Copilot 代码审查的强大功能