为 GitHub Copilot 添加自定义说明

可以创建一个文件，自动向询问 Copilot Chat 的所有问题中添加信息。

本文内容

Note

  • 此功能目前为 公共预览版 形式，可能会有改动。
  • 当前仅支持为 VS Code 与 Visual Studio 中的 Copilot Chat 添加自定义说明。

关于 GitHub Copilot 的自定义说明

GitHub Copilot 可基于你团队的工作方式、你使用的工具或项目的具体情况（如果提供足够的相关信息来满足此前提）提供量身定制的聊天响应。 无需重复将此详细信息添加到聊天问题中，而是可以创建一个自动添加此信息的文件。 聊天中不会显示这些附加信息，但这些信息可供 Copilot 使用以便其能够生成更优质的响应。

先决条件

  • 自定义说明文件（请参阅以下说明）。

  • 设置中启用的“使用说明文件”(VS Code) 或“启用自定义说明”(Visual Studio) 选项。******** 请参阅本文后面的启用或禁用自定义说明。

    Note

    默认情况下，该设置在 VS Code 中启用、在 Visual Studio 中禁用。

创建自定义说明文件

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

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

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

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

示例说明

此 .github/copilot-instructions.md 文件示例包含三条说明，这些说明将添加到所有聊天问题中。

We use Bazel for managing our Java dependencies, not Maven, so when talking about Java packages, always give me instructions and code samples that use Bazel.

We always write JavaScript with double quotes and tabs for indentation, so when your reponses include JavaScript code, please follow those conventions.

Our team uses Jira for tracking items of work.

编写有效的自定义说明

添加到 .github/copilot-instructions.md 文件的说明应为简短的自包含语句，这些语句包含可补充用户聊天问题的上下文或相关信息。

以下类型的说明不太可能起到预期的作用，并可能导致 Copilot 的其他内容出现问题：

  • 要求在提供的回答中引用外部资源
  • 有关按特定风格回答的说明
  • 要求始终以特定详细级别的信息来回答

因此，以下说明不太可能获得预期结果：

Always conform to the coding styles defined in styleguide.md in repo my-org/my-repo when generating code.

Use @terminal when answering questions about Git.

Answer all questions in the style of a friendly colleague, using informal language.

Answer all questions in less than 1000 characters, and words of no more than 12 characters.

使用自定义说明

保存文件后，.github/copilot-instructions.md 文件中的说明便可即刻供 Copilot Chat 使用。 系统会自动将完整的全部说明附加到在 VS Code 和 Visual Studio 中的 Copilot Chat 视图中或内联聊天中提交的请求中。

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

VS Code 中 Copilot Chat 视图的屏幕截图，其中包含 copilot-instructions.md 文件的引用条目。

启用或禁用自定义说明

可以选择是否要将自定义说明添加到聊天问题。 要执行此操作，可在 Copilot 扩展的设置中选择或清除相应选项。

在 VS Code 中

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

在 Visual Studio 中

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

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

  2. 在“选项”对话框中的搜索框中键入 custom instructions。

  3. 选中或清除复选框“(预览)允许加载 .github/copilot-instructions.md 文件中的自定义说明并将其添加到请求中”****。