情境至关重要：通过自定义指令获得更佳 AI 结果

2025 年 3 月 26 日，作者：Rob Conery，@robconery.com，Burke Holland，@burkeholland

本月早些时候，我们宣布正式发布 Visual Studio Code 中的自定义指令。自定义指令让您可以为 Copilot 提供关于您团队工作流程、您特定的风格偏好、模型可能不了解的库等等的具体情境。

在这篇文章中，我们将深入探讨什么是自定义指令，如何立即使用它们来显著改善 GitHub Copilot 的结果，甚至还有一个名为“提示文件”的全新预览功能，您可以立即试用。

更小的提示，更好的结果，只需一个简单的 Markdown 文件

使用 GitHub Copilot 可以为您的开发过程增添动力，但在有效提示方面存在一个学习曲线。可能需要多次尝试才能获得您想要的正确答案，这通常意味着需要重新措辞您的问题或提示。即便如此，Copilot 仍然会加快您的工作流程！

但您是否知道可以“调整” GitHub Copilot 以更好地满足您的需求？通过使用一个简单的 Markdown 文件，您可以为 Copilot 提供具体的指令，帮助它更好地理解您的项目。在这篇文章中，我们将引导您完成创建和使用自定义指令的过程，这是 VS Code 中新发布的功能。

尝试一下：在您的项目中创建一个名为 .github/copilot-instructions.md 的文件。此文件将包含帮助 Copilot 更好地理解您的项目的指令。它会被 Copilot 自动拾取，因此您无需执行任何特殊操作即可使其工作。

将这些指令添加到文件中

# Copilot Instructions

This project is a web application that allows users to create and manage tasks. The application is built using React and Node.js, and it uses MongoDB as the database.

## Coding Standards

- Use camelCase for variable and function names.
- Use PascalCase for component names.
- Use single quotes for strings.
- Use 2 spaces for indentation.
- Use arrow functions for callbacks.
- Use async/await for asynchronous code.
- Use const for constants and let for variables that will be reassigned.
- Use destructuring for objects and arrays.
- Use template literals for strings that contain variables.
- Use the latest JavaScript features (ES6+) where possible.

标题不是绝对必要的，但它有助于阐明文件的目的。其余内容是一组指令，可帮助 Copilot 更好地理解您的项目。您可以自定义这些指令以适应您项目的需求。

现在，打开聊天视图，并使用一个非常简洁的命令提示它，例如 尾递归。您不必问“如何在 JavaScript 中进行尾递归”或类似的问题。只需键入 尾递归 并按 Enter 键。请注意，Copilot 了解您的项目情境，并为您提供相关的答案。

请注意，即使您使用了更小的提示，Copilot 也为您提供了更详细的答案，并且格式符合您的预期（2 个空格，camelCase 等）。

这就是使用自定义指令的力量！但您还可以做更多的事情...

自定义一切！

GitHub Copilot 为 VS Code 添加了许多强大的功能，包括生成您的提交消息、审查选定的代码，甚至生成测试！

这些都很有用，但您很可能也有自己做事的方式。好消息是，您可以通过覆盖工作区中的一些设置来对其进行个性化设置。

尝试一下：打开命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 并键入短语“workspace settings”。您应该看到一个菜单选项，上面写着首选项：打开工作区设置 (JSON)。选择该选项并将以下设置添加到您的工作区

{
  "github.copilot.chat.commitMessageGeneration.instructions": [
    {
      "text": "Be extremely detailed with the file changes and the reason for the change. Use lots of emojis."
    }
  ]
}

保存 settings.json 文件并关闭它。活动栏中的源代码管理图标现在应指示您已更改文件。如果您在没有 Git 仓库的测试目录中工作，您可以直接通过源代码管理视图创建一个。只需选择初始化仓库按钮并按照说明操作即可。

有趣的部分来了：打开源代码管理视图，然后在提交消息输入字段中选择闪光图标。这会指示 Copilot 为您生成提交消息。请注意，它生成的提交消息非常详细，并使用了大量表情符号！

注释掉您的 settings.json 文件中的指令，然后再次生成提交消息。您应该看到一个不太详细的提交消息，并且不使用任何表情符号。

编写良好、详细的提交消息是一项需要时间学习的技能。但是借助 Copilot，您可以节省大量时间并获得更好的消息。

全力投入自定义指令

您可能将编码标准放在不同的文件中，格式也可能与 Markdown 不同。也许您有一个用于 JavaScript，一个用于 Python，还有一个用于 Go 的标准。您可能还有关于如何使用数据库的标准——您使用的数据类型、命名约定、连接字符串处理等等。

您不必将所有这些都合并到一个文件中。您可以将它们分开，并且仍然可以使用 Copilot 来帮助您处理所有这些！

让我们试试看！打开您的 .vscode/settings.json 文件（工作区设置）并添加以下设置

{
  "github.copilot.chat.codeGeneration.instructions": [
    {
      "file": "./docs/javascript-styles.md"
    },
    {
      "file": "./docs/database-styles.md"
    }
  ]
}

这指示 Copilot 在 docs 目录中查找两个文件：javascript-styles.md 和 database-styles.md。您可以根据需要添加任意数量的文件，Copilot 将按照您指定的顺序查找它们。

您可以在此处添加任何您喜欢的文件，包括您当前冲刺的规范。我们甚至看到有人将 Gherkin 规范添加为自定义指令！

试试看！

更改模型语气

模型往往过于客气。它们经常道歉，如果您告诉它们某些事情是错误的，它们几乎从不为自己和它们所做的决定辩护。当您尝试完成工作时，这可能会令人恼火。您可以使用一些关于您希望模型如何响应的指令来覆盖模型过于乐于助人的语气。

- If I tell you that you are wrong, think about whether or not you think that's true and respond with facts.
- Avoid apologizing or making conciliatory statements.
- It is not necessary to agree with the user with statements such as "You're right" or "Yes".
- Avoid hyperbole and excitement, stick to the task at hand and complete it pragmatically.

重要的是始终以肯定的方式而不是否定方式给模型指令，因为它们需要知道该怎么做，而不是不该做什么。与其说“不要做”，不如说“避免”。

尝试并享受乐趣！一位程序员报告说，他们喜欢通过用俳句生成测试来活跃他们的测试套件。这似乎有点极端，但如果您正在从事一个业余项目，为什么不呢？您可以添加如下指令

- Generate tests in haiku format.
- Use 5-7-5 syllable structure.
- Use nature themes and imagery.

还有一件事...

GitHub Copilot 也可以理解代码文件作为自定义指令！例如，如果您有一个 SQL 文件，您可以将其添加到您的设置中，Copilot 将使用它来帮助生成您的数据访问代码。

如果您有自己喜欢的特定数据访问工具，您可以将一个示例添加到您的项目中，Copilot 将在生成数据访问代码时使用它。

试试看！这是一个我们团队成员用来为 PostgreSQL 数据库生成 Sequelize 模型 (Node.js ORM) 的示例

//Template for a Sequelize model
const { DataTypes, Model } = require('sequelize');
class User extends Model {
  //static or factory methods
  //instance methods
}
const init = function(sequelize){
  User.init({
    //schema goes here
  }, {
    hooks: {},
    tableName: "users"
    underscored: true,
    sequelize
  })
}

exports.createUser = function(sequelize){
  init(sequelize);
  return User;
}

在您的设置中引用此文件，GitHub Copilot 将使用此模板以及您的 SQL 文件来为您项目生成模型。您可以在“编辑”或“提问”模式下执行此操作。只需使用提示 为项目生成数据访问，然后 boom！神奇！

介绍提示文件

提示文件允许您为自己和您的团队编写可重用的提示。这有助于加强一致性，同时减少提示，因为提示可能会变得乏味。

例如，假设您想要创建一个可重用的提示，该提示将基于数据库模式创建接口。您可以创建一个包含您的数据库模式的提示文件。Copilot 非常乐意为您生成 SQL 脚本来完成此操作。

提示文件位于 .github/prompts 目录中，只是 Markdown 文件，名称格式为 *.prompt.md。

您可能有一个 .github/prompts/database_users.prompt.md 文件，其中包含您的数据库描述。例如

# User Authentication

Our application will have `users` with the following information:

- The standard user information, including: `name`, `email` (unique).
- A link for a "magic" login, which will be a `GUID` as well as the expiration date for the link.
- Social login account IDs for Microsoft, GitHub, and Google.
- The timestamp of the last login.
- The timestamp for when the user was created.

然后，您可以创建另一个名为 generate-interface.prompt.md 的提示文件，其中包含生成接口的指令。提示文件可以相互引用，因此您可以将数据库模式作为简单的 Markdown 链接传递到此提示文件中。

Generate a TypeScript interface for the table specified by the user. Refer to the [user schema](database_users.prompt.md).

要在聊天中使用这些提示文件，请使用附加按钮（回形针）或使用 ⌥⌘/ (Windows, Linux Ctrl+Alt+/)。从菜单中选择提示，然后选择您要使用的提示文件。请注意，当我使用 generate-interface.prompt.md 文件时，它会自动拉入 database_users.prompt.md 文件。

结论

VS Code 是一个可自定义的助手，如果配置得当，它可以成为团队工作流程不可或缺的一部分。借助自定义指令，控制权掌握在开发人员手中。

祝您编码愉快！