GitHub Copilot 新手指南:如何让 Copilot 理解你的代码库
- 自定义指令:告诉 Copilot 应该遵循哪些约定。
- Agent skills:把可复用的流程打包起来。
- 自定义 agent:为大型任务提供专门的指导。
- Model Context Protocol(MCP)服务器:把 Copilot 连接到外部工具和数据源,扩展它的能力。
从自定义指令开始
假设你让 Copilot 给应用添加一个自定义页面尺寸。完成修改只是工作的一部分,新代码还得符合团队已有的模式。 仓库级自定义指令(Repository custom instructions)为 Copilot 提供了这种基础上下文。在仓库中添加一个.github/copilot-instructions.md 文件,即可定义适用于整个仓库的指导,比如你偏好的架构、命名约定,或测试与校验方面的要求。
你还可以在 .github/instructions 目录下创建针对特定路径的指令文件。这些文件通过 applyTo 字段告诉 Copilot 什么时候该应用这些指导。
当 Copilot 处理匹配的文件时,它会同时参考仓库级指令和更具体的指导。这样既可以把通用规则集中在一处管理,又不必让所有文件类型套用同一套模板。
把可复用流程打包成 agent skills
自定义指令适合用来定义影响众多任务的标准。但有些指导只在 Copilot 执行特定流程时才有用,比如运行质量检查、准备发布,或调试失败的工作流。这正是 agent skills(智能体技能) 的用武之地。技能是一个文件夹,包含指令,以及可选的脚本和其他资源,当内容相关时 Copilot 会加载这些资源。项目级技能可以存放在 .github/skills 目录下,每个技能拥有独立的子文件夹。
例如,.github/skills/quality-checks 文件夹中可以包含一个 SKILL.md 文件,用于说明以下内容:
- Copilot 何时应使用该技能。
- 哪些脚本负责运行项目的测试和代码检查(linting)。
- 每个脚本的具体检查项。
- 常见失败的排查方法。
SKILL.md 中的描述有助于 Copilot 判断何时应用该技能。更新界面后,Copilot 可以加载 quality-checks 技能,并按照项目既定的测试和代码检查流程操作,而无需猜测该运行哪些命令。
使用自定义智能体处理更广泛的专业任务
有些任务比单一流程更为复杂。例如,无障碍性(accessibility)审查可能需要 Copilot 检查跨多个文件的组件、模板、样式和交互元素。
自定义智能体(Custom agents) 允许你为这类工作创建专用版的 Copilot。仓库级的智能体配置文件位于 .github/agents,可以定义智能体的用途、指令、工具以及相关的项目上下文。
当某类重复性工作受益于专用角色或视角时,特别是当任务可能涉及多个文件并需要调用多种工具或上下文源时,建议使用自定义智能体。
通过 MCP 服务器将 Copilot 连接到外部工具
指令、技能和智能体帮助 Copilot 理解如何在项目内工作。MCP 服务器则扩展了其访问权限和功能,使其能超越代码仓库的范畴。
MCP 服务器 将 Copilot 连接到外部工具、数据源和服务。文档服务器可以为其提供框架指导,而 Playwright 等服务器则能让 Copilot 在浏览器中打开并交互你的应用。
你可以在 Copilot 应用中浏览可用的 MCP 服务器,或添加自定义服务器。配置好 Playwright 后,你可以询问:使用 Playwright MCP 服务器手动测试功能。
Copilot 随后可以利用 Playwright 在浏览器中打开应用,并以类似人类用户的方式与其交互。这让它不仅能验证代码是否通过自动化测试,还能确认更新后的界面表现是否符合预期。
选择合适的定制类型
这些定制项各自解决不同问题,但组合使用时效果更好:
- 自定义指令规定 Copilot 在整个仓库或特定文件中应遵循的约定。
- Agent 技能将可重复的流程封装成包,Copilot 在相关场景下可自动加载。
- 自定义 Agent为更复杂的任务提供专注的领域专长与指导。
- MCP 服务器将 Copilot 与外部工具、服务及数据源连接,拓展其能力边界。
关键要点
为 Copilot 提供有用的项目上下文,可以从这四个问题入手:
- 哪条项目约定是你反复解释的?
- 哪些多步流程是你重复执行的?
- 哪项复杂任务适合交给专属的自定义 Agent?
- Copilot 需要接入哪些外部工具或数据源?
不知从何开始?社区在 Awesome Copilot 上分享了现成的指令、技能、Agent 等资源。找一个解决你重复工作流程的方案,审查其内容,并适配你仓库的工具和规范。
从小的地方做起:挑一条你常解释的约定,添加到 .github/copilot-instructions.md,观察 Copilot 如何将其应用于下一个任务。