为你的项目自定义 AI

本指南将引导你为 Visual Studio Code 中的项目设置 AI 自定义功能。你将从基础编码规范开始，逐步添加更具针对性的能力。

完成本指南后，你的项目将具备：

• 适用于每个聊天请求的全项目编码规范
• 针对前端代码的特定文件说明
• 用于常见任务的可复用提示词文件
• 具有受限工具的自定义 Agent
• 用于特定功能的技能

先决条件

• 已安装 VS Code
• 拥有 GitHub Copilot 订阅计划（Free、Pro、Business 或 Enterprise）
• 已安装 GitHub Copilot 扩展
• 在 VS Code 中打开了一个工作区或文件夹

第 1 步：设置全项目代码规范

首先生成一个包含项目编码规范的说明文件。这些说明会自动包含在每次聊天请求中。

1. 打开聊天视图（⌃⌘I (Windows、Linux 为 Ctrl+Alt+I)）。

2. 输入 /init 并按 Enter 键。

   /init
   

3. VS Code 会分析你的项目结构，并生成一个针对你代码库定制的 .github/copilot-instructions.md 文件。

4. 检查并自定义生成的文件。例如，添加关于你首选导入样式的规则。

   ## Imports
   - Use named imports instead of default imports.
   - Group imports: external libraries first, then internal modules, then relative paths.
   

5. 保存文件。

验证生效：要求 Copilot 生成一些代码（例如，“创建一个日期格式化的工具函数”）。检查响应是否遵循了你的编码规范。在聊天响应中选择引用 (References) 部分，确认 copilot-instructions.md 已被包含在内。

第 2 步：添加特定文件说明

当代码库的不同部分遵循不同规范时，可以使用带有 applyTo 模式的说明文件来针对特定文件类型进行配置。

1. 打开聊天视图（⌃⌘I (Windows、Linux 为 Ctrl+Alt+I)）。

2. 输入 /create-instructions，后跟你要创建的说明描述，然后按 Enter 键。

   /create-instructions React-specific coding standards
   

3. 回答有关这些说明的澄清问题，并查看生成的说明文件。

验证生效：打开一个 .tsx 文件，要求 Copilot “创建一个用户资料卡片组件”。响应应遵循你特定的 React 规范。检查引用部分以确认说明文件已生效。

第 3 步：创建可复用的提示词（Prompt）文件

提示词（Prompt）文件将常见任务编码为可以在聊天中调用的斜杠命令。为你经常执行的任务创建一个提示词文件。

1. 打开聊天视图（⌃⌘I (Windows、Linux 为 Ctrl+Alt+I)）。

2. 输入 /create-prompt，后跟你要创建的提示词描述，然后按 Enter 键。

   /create-prompt Scaffold a new React component with tests
   

3. 回答有关该提示词的澄清问题，并查看生成的提示词文件。

验证生效：在聊天视图中，输入 /<prompt name> data table with sorting and filtering 并按 Enter 键。Agent 应根据你的规范构建组件和测试文件。

第 4 步：构建自定义 Agent

自定义 Agent 让 AI 可以采取具有特定工具访问权限的专业角色。创建一个只能读取代码而不能修改代码的代码审查 Agent。

1. 打开聊天视图（⌃⌘I (Windows、Linux 为 Ctrl+Alt+I)）。

2. 输入 /create-agent，后跟你要创建的 Agent 描述，然后按 Enter 键。

   /create-agent A code reviewer that analyzes code for quality, security, and best practices without modifying files
   

3. 回答有关该 Agent 的澄清问题，并查看生成的 Agent 文件。

验证生效：在聊天视图的 Agent 下拉菜单中选择 Reviewer Agent，然后询问“审查身份验证模块”。Agent 应分析代码而不进行任何更改。

第 5 步：创建用于特定功能的技能（Skill）

技能（Skills）是包含说明、脚本和资源的文件夹，Copilot 在执行特定任务时会加载这些内容。与定义编码规范的说明文件不同，技能教会 Copilot 如何执行特定的工作流。

1. 从命令面板运行 Chat: Open Customizations 命令（⇧⌘P (Windows, Linux Ctrl+Shift+P)）以打开聊天自定义编辑器。

2. 选择 Skills 选项卡，然后从下拉菜单中选择 New Skill (Workspace)。

3. 输入技能名称，例如 update-readme，然后按 Enter 键。

4. 将以下内容添加到 SKILL.md 文件中。

   ---
   name: update-readme
   description: Update the project README to reflect recent code changes. Whenever code changes are made, this skill reviews the changes and updates the README with new features, usage instructions, and API references.
   ---
   # Update README
   
   When updating the README:
   1. Review recent code changes to identify new or modified features
   2. Update the relevant sections (installation, usage, API reference)
   3. Add entries for new commands, configuration options, or environment variables
   4. Remove documentation for deleted or deprecated features
   5. Keep the existing tone, structure, and formatting conventions
   

验证生效：在聊天中，要求 Copilot 为你的项目添加一个新功能（例如，“添加一个健康检查端点”）。当它生成代码时，它也应自动使用新端点的文档更新 README。你也可以直接在聊天视图中输入 /update-readme 来调用该技能。

你所构建的内容

你的项目现在拥有了一套分层的 AI 自定义配置。

your-project/
  .github/
    copilot-instructions.md          # Project-wide coding standards (Step 1)
    instructions/
      react.instructions.md          # React-specific conventions (Step 2)
    prompts/
      create-component.prompt.md     # Reusable component scaffolding (Step 3)
    agents/
      reviewer.agent.md              # Read-only code reviewer (Step 4)
    skills/
      update-readme/
        SKILL.md                     # README updater workflow (Step 5)

后续步骤

• 添加 MCP 服务器，通过外部工具和服务扩展 Agent 能力。
• 设置 钩子 (hooks) 以在 Agent 生命周期节点自动执行任务，例如在每次文件编辑后运行格式化程序。
• 浏览 Agent 插件，从社区市场安装预打包的自定义功能。
• 通过将 .github/ 目录提交到你的代码仓库，与团队共享自定义配置。
• 使用 聊天自定义编辑器 在一个地方查看所有自定义配置。