在 IDE 中添加 GitHub Copilot 的存储库自定义说明

创建存储库自定义说明文件，以提供有关 Copilot 如何了解项目以及如何生成、测试和验证其更改的其他上下文。

Tool navigation

在本文中

本版本的文章适用于在VS Code中使用存储库自定义说明和提示文件。 单击上面的选项卡，获取有关在其他环境中使用自定义说明的说明。

介绍

通过存储库自定义说明，可以为 Copilot 提供特定于存储库的指导和首选项。 有关详细信息，请参阅“关于自定义GitHub Copilot 响应”。

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

  • 必须有自定义指令文件（请参阅以下指令）。

  • 必须启用自定义说明。 此功能默认处于启用状态。 请参阅本文后面的启用或禁用存储库自定义说明。

创建自定义指令

          VS Code 支持三种类型的存储库自定义说明。 有关哪些 GitHub Copilot 功能支持这些类型的说明的详细信息，请参阅 [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=vscode#support-for-repository-custom-instructions-1)。

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

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

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

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

    如果指定的路径与正在处理的文件 Copilot 匹配，并且还存在存储库范围的自定义指令文件，则使用这两个文件中的说明。

  • 智能体指令供 AI 智能体使用。

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

    注意

            `AGENTS.md`工作区根目录外部的文件支持目前默认处于关闭状态。 有关启用此功能的详细信息，请参阅文档中的[在 VS Code 中使用自定义说明](https://code.visualstudio.com/docs/copilot/customization/custom-instructions#_use-an-agentsmd-file)VS Code。

创建全仓库内的自定义指令

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

    如果尚无 .github 目录，则创建该目录。

  2. 以 Markdown 格式在该文件中添加自然语言说明。

    系统会忽略说明信息间的空格，因此可将信息编写为一个段落，每个段落位于一行上，或用空白行分隔，以保持其可读性。

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

  1. 如果尚无 .github/instructions 目录，则创建该目录。

  2. （可选）创建用于组织指令文件的子目录 .github/instructions 。

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

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

    例如：

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

    可以通过用逗号分隔多个模式来指定这些模式。 例如，若要将指令应用于仓库中的所有 TypeScript 文件，可以使用以下前辅文块：

    ---
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` - 将递归匹配任意深度下任意 `subdir` 目录中的所有 `.py` 文件。 例如，`subdir/foo.py`、`subdir/nested/bar.py`、`parent/subdir/baz.py` 和 `deep/parent/subdir/nested/qux.py`，但不匹配_不_`foo.py`包含 `subdir` 目录的路径。

  5. 或者，为了防止文件被 Copilot云代理 或 Copilot 代码评审 使用，将 excludeAgent 关键字添加到 frontmatter 区块中。 使用 "code-review" 或 "cloud-agent"。

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

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

    如果在 front matterblock 中不包括关键字 excludeAgent，则 Copilot 代码评审 和 Copilot云代理 都将使用您的说明。

  6. 使用 Markdown 格式以自然语言添加自定义指令。 系统会忽略说明信息间的空格，因此可将信息编写为一个段落，每个段落位于一行上，或用空白行分隔，以保持其可读性。

你是否已成功将自定义指令文件添加到你的仓库中？

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

正在使用的自定义说明

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

自定义说明在“聊天”视图或内联聊天中不可见，但可以通过查看“聊天”视图中的回复引用列表来验证 Copilot 是否正在使用这些说明。 如果将自定义说明添加到发送到模型的提示中，引用信息中会列出文件 .github/copilot-instructions.md。 可以单击引用信息来打开该文件。

展开的“References”列表的屏幕截图，其中用深橙色边框突出显示了“copilot-instructions.md”文件。

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

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

为 副驾驶聊天 启用或禁用自定义指令

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

  1. 使用键盘快捷方式 Command+, (Mac)/Ctrl+, (Linux/Windows) 打开“设置编辑器”。
  2. 在搜索框中键入 instruction file。
  3. 选中或清除“代码生成: 使用说明文件”**** 下的复选框。

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

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

  1. 在 GitHub 上，导航到存储库的主页面。

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

    存储库标头的屏幕截图，其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  3. 在边栏的“Code & automation”部分，单击 Copilot，然后单击“Code review”********。

  4. 打开或关闭“Use custom instructions when reviewing pull requests”选项。

启用并使用提示文件

注意

通过提示文件，你可以使用额外的上下文生成和共享可重用的提示说明。 提示文件是一个存储在工作区中的 Markdown 文件，它与现有的 副驾驶聊天 中的写作提示格式保持一致（例如，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. 在视图底部 副驾驶聊天 ，单击 “附加上下文 ”图标（）。

  2. 在下拉菜单中，单击“Prompt...”并选择要使用的提示文件****。

  3. （可选）附加其他文件（包括提示文件）以提供更多上下文。

  4. （可选）在聊天提示框中键入其他信息。

    是否需要执行此操作取决于所使用的提示的内容。

  5. 提交聊天提示。

有关提示文件的详细信息，请参阅在Visual Studio Code中的Visual Studio Code。

延伸阅读

此版本的文章适用于在 Visual Studio 中使用存储库自定义说明和提示文件。 单击上面的选项卡，获取有关在其他环境中使用自定义说明的说明。

介绍

通过存储库自定义说明，可以为 Copilot 提供特定于存储库的指导和首选项。 有关详细信息，请参阅“关于自定义GitHub Copilot 响应”。

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

  • 必须有自定义指令文件（请参阅以下指令）。

  • 必须在设置中启用“Enable custom instructions...”选项。**** 此项已默认启用。 请参阅本文后面的启用或禁用存储库自定义说明。

创建自定义指令

          Visual Studio 支持两种类型的自定义指令。 有关哪些 GitHub Copilot 功能支持这些类型的说明的详细信息，请参阅 [AUTOTITLE](/copilot/concepts/prompting/response-customization?tool=visualstudio#support-for-repository-custom-instructions-2)。

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

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

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

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

    如果指定的路径与正在处理的文件 Copilot 匹配，并且还存在存储库范围的自定义指令文件，则使用这两个文件中的说明。

创建全仓库内的自定义指令

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

    如果尚无 .github 目录，则创建该目录。

  2. 以 Markdown 格式在该文件中添加自然语言说明。

    系统会忽略说明信息间的空格，因此可将信息编写为一个段落，每个段落位于一行上，或用空白行分隔，以保持其可读性。

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

  1. 如果尚无 .github/instructions 目录，则创建该目录。

  2. （可选）创建用于组织指令文件的子目录 .github/instructions 。

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

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

    例如：

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

    可以通过用逗号分隔多个模式来指定这些模式。 例如，若要将指令应用于仓库中的所有 TypeScript 文件，可以使用以下前辅文块：

    ---
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` - 将递归匹配任意深度下任意 `subdir` 目录中的所有 `.py` 文件。 例如，`subdir/foo.py`、`subdir/nested/bar.py`、`parent/subdir/baz.py` 和 `deep/parent/subdir/nested/qux.py`，但不匹配_不_`foo.py`包含 `subdir` 目录的路径。

  5. 或者，为了防止文件被 Copilot云代理 或 Copilot 代码评审 使用，将 excludeAgent 关键字添加到 frontmatter 区块中。 使用 "code-review" 或 "cloud-agent"。

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

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

    如果在 front matterblock 中不包括关键字 excludeAgent，则 Copilot 代码评审 和 Copilot云代理 都将使用您的说明。

  6. 使用 Markdown 格式以自然语言添加自定义指令。 系统会忽略说明信息间的空格，因此可将信息编写为一个段落，每个段落位于一行上，或用空白行分隔，以保持其可读性。

你是否已成功将自定义指令文件添加到你的仓库中？

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

正在使用的自定义说明

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

自定义说明在“聊天”视图或内联聊天中不可见，但可以通过查看“聊天”视图中的回复引用列表来验证 Copilot 是否正在使用这些说明。 如果将自定义说明添加到发送到模型的提示中，引用信息中会列出文件 .github/copilot-instructions.md。 可以单击引用信息来打开该文件。

“References”弹出窗口的屏幕截图，其中用深橙色边框突出显示了“copilot-instructions.md”文件。

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

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

为 副驾驶聊天 启用或禁用自定义指令

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

  1. 在 Visual Studio 菜单栏中的 “工具”下，单击“ 选项”。

    Visual Studio 菜单栏的屏幕截图。 “工具”菜单已展开，“选项”项以橙色边框突出显示。

  2. 在“选项”对话框中，键入 custom instructions 搜索框，然后单击 Copilot。

  3. 选中或清除复选框“启用自定义说明从 .github/copilot-instructions.md 文件加载并添加到请求中”****。

    Visual Studio 的“Options”对话框的屏幕截图，显示已选中“Enable custom instructions”选项复选框。

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

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

  1. 在 GitHub 上，导航到存储库的主页面。

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

    存储库标头的屏幕截图，其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  3. 在边栏的“Code & automation”部分，单击 Copilot，然后单击“Code review”********。

  4. 打开或关闭“Use custom instructions when reviewing pull requests”选项。

使用提示文件

注意

通过提示文件，你可以使用额外的上下文生成和共享可重用的提示说明。 提示文件是一个存储在工作区中的 Markdown 文件，它与现有的 副驾驶聊天 中的写作提示格式保持一致（例如，Rewrite #file:x.ts）。 你在工作区中可以有多个提示文件，每个提示文件都定义一个用于不同目的的提示。

创建提示文件

  1. 在存储库的根目录中添加一个提示文件，其中包括 .prompt.md 名称扩展名的文件位于 .github/prompts 文件夹内。 该名称可以包含字母数字字符和空格，且应描述文件将包含的提示信息的目的。

  2. 使用 Markdown 格式编写提示说明。

    可以使用 Markdown 链接（例如 [index](../../web/index.ts)）或使用 #file:'../../web/index.ts' 语法来引用工作区中的其他文件。 路径是相对于提示文件的。 通过引用其他文件，可以提供其他上下文，例如 API 规范或产品文档。

有关提示文件的详细信息，请参阅Visual Studio中的使用提示文件Visual Studio。

延伸阅读

本文的此版本适用于在 JetBrains IDE 中使用仓库自定义指令。 单击上面的选项卡，获取有关在其他环境中使用自定义说明的说明。

介绍

通过存储库自定义说明，可以为 Copilot 提供特定于存储库的指导和首选项。 有关详细信息，请参阅“关于自定义GitHub Copilot 响应”。

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

  • 必须有自定义指令文件（请参阅以下指令）。

  • 必须在 JetBrains IDE 中安装最新版本的 Copilot 扩展。

创建自定义指令

JetBrains IDE 支持存储在仓库中的单个 .github/copilot-instructions.md 自定义指令文件，和本地存储的 global-copilot-instructions.md 文件。

可以使用 .github/copilot-instructions.md 设置页在存储库 Copilot 中创建文件，也可以手动创建该文件。

系统会忽略说明信息间的空格，因此可将信息编写为一个段落，每个段落位于一行上，或用空白行分隔，以保持其可读性。

访问设置页面

  1. 在 JetBrains IDE 中，单击“文件”**** 菜单 (Windows) 或菜单栏中的应用程序名称 (macOS)，然后单击“设置”****。

           1. 在左侧栏中，单击 **工具**，单击 **GitHub Copilot**，然后单击 **“自定义**”。

  2. 在“说明”Copilot 下，单击 “工作区 ”或“ 全局 ”，选择自定义说明是应用于当前工作区还是所有工作区。

手动创建工作区自定义指令文件

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

    如果尚无 .github 目录，则创建该目录。

  2. 以 Markdown 格式在该文件中添加自然语言说明。

保存后，这些说明将应用于打开且已启用的 Copilot JetBrains IDE 中的当前工作区。

手动创建全局自定义指令文件

要在 JetBrains IDE 中的所有工作区中应用相同的指令，可以在本地计算机上创建全局自定义指令文件。

  1. 打开文件资源管理器或终端。

  2. 导航到操作系统的相应位置：

    • macOS：****
    • Windows：C:\Users\YOUR-USERNAME\AppData\Local\github-copilot\intellij\

  3. 在此目录中创建名为 global-copilot-instructions.md 的文件。

  4. 使用 Markdown 格式以自然语言添加自定义指令。

保存后，这些说明将全局应用于已启用的 Copilot JetBrains IDE 中的所有工作区。

你是否已成功将自定义指令文件添加到你的仓库中？

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

正在使用的自定义说明

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

自定义说明在“聊天”视图或内联聊天中不可见，但可以通过查看“聊天”视图中的回复引用列表来验证 Copilot 是否正在使用这些说明。 如果将自定义说明添加到发送到模型的提示中，引用信息中会列出文件 .github/copilot-instructions.md。 可以单击引用信息来打开该文件。

使用提示文件

注意

通过提示文件，你可以使用额外的上下文生成和共享可重用的提示说明。 提示文件是一个存储在工作区中的 Markdown 文件，它与现有的 副驾驶聊天 中的写作提示格式保持一致（例如，Rewrite #file:x.ts）。 你在工作区中可以有多个提示文件，每个提示文件都定义一个用于不同目的的提示。

编写提示说明时，可以使用 Markdown 链接（例如） [index](../../web/index.ts)或使用 #file:../../web/index.ts 语法来引用工作区中的其他文件。 路径是相对于提示文件的。 通过引用其他文件，可以提供其他上下文，例如 API 规范或产品文档。

保存提示文件后，其说明将应用于打开且已启用的 Copilot JetBrains IDE 中的当前工作区。

使用命令行创建提示文件

  1. 如果工作区中尚不存在目录 .github/prompts ，请创建该目录。 此目录将是提示文件的位置。
  2. 在 .github/prompts 目录中创建提示文件。 提示文件名可以包含字母数字字符和空格，应描述文件将包含的提示信息的目的。 文件名必须以 .prompt.md 文件扩展名结尾，例如 TESTPROMPT.prompt.md。
  3. 使用 Markdown 格式编写提示说明，并保存文件。

使用“设置”页创建提示文件

  1. 在 JetBrains IDE 中，单击“文件”**** 菜单 (Windows) 或菜单栏中的应用程序名称 (macOS)，然后单击“设置”****。
  2. 在 “工具” 下 GitHub Copilot，单击“ 编辑设置”。
  3. 在“设置类别”下，单击 “自定义”。
  4. 在“提示文件”下，单击“ 工作区”，在工作区中创建提示文件。
  5. 输入提示文件的名称，不包括 .prompt.md 文件扩展名。 提示文件名可以包含字母数字字符和空格，应描述文件将包含的提示信息的目的。
  6. 单击“ 确定” 保存提示文件名。
  7. 使用 Markdown 格式编写提示说明，并保存文件。

使用提示文件

  1. 在聊天输入框中，键入 / 后跟提示文件的名称。 例如，/TESTPROMPT。

  2. （可选）附加其他文件以提供更多上下文。

  3. （可选）在聊天提示框中键入其他信息。

    是否需要执行此操作取决于所使用的提示的内容。

  4. 提交聊天提示。

延伸阅读

本文的此版本适用于在 Xcode 中使用仓库自定义指令。 单击上面的选项卡，获取有关在其他环境中使用自定义说明的说明。

介绍

通过存储库自定义说明，可以为 Copilot 提供特定于存储库的指导和首选项。 有关详细信息，请参阅“关于自定义GitHub Copilot 响应”。

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

  • 必须有自定义指令文件（请参阅以下指令）。

  • 必须在 Xcode 中安装最新版本的 Copilot 扩展。

创建自定义指令

Xcode 支持存储在存储库中的单个 .github/copilot-instructions.md 自定义说明文件。

可以通过设置页在存储库 Copilot 中创建自定义说明文件。

系统会忽略说明信息间的空格，因此可将信息编写为一个段落，每个段落位于一行上，或用空白行分隔，以保持其可读性。

  1. 打开 GitHub Copilot Xcode 应用程序。
  2. 在应用程序窗口顶部的“Settings”下，单击“Advanced”********。
  3. 在“Custom Instructions”的右侧，单击“Current Workspace”或“Global”，选择自定义指令是应用于当前工作区还是适用于所有工作区********。

你是否已成功将自定义指令文件添加到你的仓库中？

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

正在使用的自定义说明

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

自定义说明在“聊天”视图或内联聊天中不可见，但可以通过查看“聊天”视图中的回复引用列表来验证 Copilot 是否正在使用这些说明。 如果将自定义说明添加到发送到模型的提示中，引用信息中会列出文件 .github/copilot-instructions.md。 可以单击引用信息来打开该文件。

延伸阅读

注意

此功能目前处于状态 公共预览版 ，可能会更改。

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

介绍

通过存储库自定义说明，可以为 Copilot 提供特定于存储库的指导和首选项。 有关详细信息，请参阅“关于自定义GitHub Copilot 响应”。

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

  • 必须有自定义指令文件（请参阅以下指令）。

  • 必须在 Eclipse 中安装最新版本的 Copilot 扩展。

创建自定义指令

Eclipse 支持两种类型的存储库自定义说明：工作区和项目自定义说明。

若要创建工作区自定义说明文件，可以使用 Copilot 设置页。 若要创建项目自定义说明文件，可以在项目目录中手动创建该文件。

系统会忽略说明信息间的空格，因此可将信息编写为一个段落，每个段落位于一行上，或用空白行分隔，以保持其可读性。

创建工作区自定义说明文件

  1. 若要打开 副驾驶聊天 面板，请单击 Copilot Eclipse 底部状态栏中的图标（）。
  2. 从菜单中选择“Edit preferences”。
  3. 在左窗格中，展开 GitHub Copilot 并单击“ 自定义说明”。
  4. 选择启用工作区说明。
  5. 在“工作区”部分中，在“设置自定义说明以指导 Copilot此工作区中的代码建议”下，以 Markdown 格式向文件添加自然语言说明。

创建项目自定义说明文件

  1. 在项目根目录中，创建一个名为 .github/copilot-instructions.md 的文件。
  2. 使用 Markdown 格式以自然语言添加自定义指令。

保存后，这些说明将应用于 Eclipse 中打开且已启用的 Copilot 当前项目。

你是否已成功将自定义指令文件添加到你的仓库中？

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

正在使用的自定义说明

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

延伸阅读