在 VS Code 中为 GitHub Copilot 自定义指令

您可以通过向 Copilot 提供有关团队工作流程、工具或项目细节的上下文信息来增强其聊天回复。无需在每个聊天查询中手动包含此上下文，您可以创建一个自定义指令文件，该文件会在每次聊天请求时自动包含此信息。

Copilot 会将这些指令应用于聊天视图、快速聊天或内联聊天的聊天提示。这些指令不会显示在聊天中，但会由 VS Code 传递给 Copilot。

您可以为特定目的指定自定义指令：

• 代码生成指令 - 提供特定于代码生成的上下文。例如，您可以指定私有变量应始终以下划线为前缀，或者以某种方式实现单例。您可以在设置中或工作区中的 Markdown 文件中指定代码生成指令。
• 测试生成指令 - 提供特定于测试生成的上下文。例如，您可以指定所有生成的测试都应使用特定的测试框架。您可以在设置中或工作区中的 Markdown 文件中指定测试生成指令。

自定义指令由自然语言指令组成，应简短、独立的语句，以添加上下文或相关信息来补充聊天问题。

定义代码生成自定义指令

Copilot 可以帮助您生成代码，例如作为重构、生成单元测试或实现功能的一部分。您可能希望在项目中使用特定的库，或者希望遵循 Copilot 生成的代码的特定编码风格。

注意：Copilot 不会为代码补全应用代码生成指令。

使用设置

您可以使用 ​github.copilot.chat.codeGeneration.instructions​ 设置来配置自定义代码生成指令。您可以在用户级或工作区级定义自定义指令，也可以指定特定于语言的指令。

以下代码片段显示了如何在 settings.json 文件中定义一组指令。要直接在设置中定义指令，请配置 text 属性。要引用外部文件，请配置 file 属性。

  "github.copilot.chat.codeGeneration.instructions": [
    {
      "text": "Always add a comment: 'Generated by Copilot'."
    },
    {
      "text": "In TypeScript always use underscore for private field names."
    },
    {
      "file": "code-style.md" // import instructions from file `code-style.md`
    }
  ],

​code-style.md​ 文件内容的示例：

Always use React functional components.

Always add comments.

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

您也可以将自定义指令存储在工作区或存储库中的 .github/copilot-instructions.md 文件中，并让 VS Code 自动拾取此文件。

如果您同时在 .github/copilot-instructions.md 文件和设置中定义自定义指令，Copilot 会尝试组合来自这两个来源的指令。

注意：Visual Studio 中的 GitHub Copilot 也检测 .github/copilot-instructions.md 文件。如果您有一个在 VS Code 和 Visual Studio 中都使用的工作区，则可以使用同一个文件为这两个编辑器定义自定义指令。

将 ​github.copilot.chat.codeGeneration.useInstructionFiles​ 设置设置为 ​true​ 以指示 VS Code 中的 Copilot 使用自定义指令文件。

在工作区的根目录创建 .github/copilot-instructions.md 文件。如有必要，请先创建一个 .github 目录。

提示：在 VS Code 的资源管理器视图中，您可以通过将完整路径作为文件名输入来在一个操作中创建文件夹和文件。

向文件中添加自然语言指令。您可以使用 Markdown 格式。

指令之间的空格将被忽略，因此可以将指令编写为单个段落、每行一个，或者为了清晰起见用空行分隔。

定义测试生成自定义指令

您可以使用 Copilot 为代码生成测试，例如通过在聊天视图中使用 ​@workspace /tests​提示。您可以定义自定义指令来帮助 Copilot 生成特定于您的项目和开发工作流程的测试。

要配置自定义测试生成指令，请使用 ​github.copilot.chat.testGeneration.instructions​ 设置。您可以在用户级或工作区级定义自定义指令。

以下代码片段显示了如何在 settings.json 文件中定义一组指令。要直接在设置中定义指令，请配置 text 属性。要引用外部文件，请配置 file 属性。

  "github.copilot.chat.testGeneration.instructions": [
    {
      "text": "Always use vitest for testing React components."
    },
    {
      "text": "Use Jest for testing JavaScript code."
    },
    {
      "file": "code-style.md" // import instructions from file `code-style.md`
    }
  ],

​code-style.md​ 文件内容的示例：

Always add code comments.

Always use React functional components.

定义自定义指令的提示

保持指令简短且独立。每个指令都应该是一个单一的简单语句。如果您需要提供多条信息，请使用多个指令。

不要在指令中引用外部资源，例如特定的编码标准。
通过将指令存储在外部文件中，可以轻松地与团队或跨项目共享自定义指令。您还可以对文件进行版本控制以跟踪随时间推移的更改。

设置

• ​github.copilot.chat.codeGeneration.instructions​：添加到生成代码的 Copilot 请求的一组指令。
• ​github.copilot.chat.codeGeneration.useInstructionFiles​：控制是否将来自 .github/copilot-instructions.md 的代码指令添加到 Copilot 请求中。
• ​github.copilot.chat.testGeneration.instructions​：添加到生成测试的 Copilot 请求的一组指令。