Copilot 自定义指令实战:缺陷复现的 prompt.md 示例
把「缺陷复现」交给智能体,难点不在模型能力,而在流程是否说清楚:输入是什么(缺陷描述与日志),按什么顺序处理,交付什么(最小复现与失败测试),哪些事不能做。Skill 就是把这些写下来的载体。
本文介绍如何在 GitHub Copilot 指令与提示文件 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | 缺陷复现(bug-repro) |
| 作用 | 根据缺陷报告写出最小复现步骤与失败测试 |
| 输入 | 缺陷描述与日志 |
| 输出 | 最小复现与失败测试 |
| 形态 | 带脚本 |
| 风险 | 低 |
| 适用人群 | 开发与测试工程师 |
处理流程分四步:
- 提取关键条件
- 缩小输入
- 写出失败测试
- 确认在修复前稳定失败
这个技能需要运行本地脚本(解析文件、调用命令行工具等),要求运行环境允许执行代码;风险较低,但输出仍需快速过目再使用。
在 GitHub Copilot 指令与提示文件 中是什么形态
GitHub Copilot 支持仓库级自定义指令文件 .github/copilot-instructions.md,以及放在 .github/prompts/ 下、以 .prompt.md 结尾的可复用提示文件,适合把固定流程交给 Copilot Chat 或智能体模式执行。
仓库级指令对该仓库的对话默认生效;提示文件需要在支持的编辑器中手动调用,具体支持情况以 Copilot 文档为准。
示例配置
.github/prompts/bug-repro.prompt.md 示例(示意):
---
description: 缺陷复现
---
请对我提供的缺陷描述与日志执行「缺陷复现」:
1. 提取关键条件
2. 缩小输入
3. 写出失败测试
4. 确认在修复前稳定失败
输出格式:最小复现与失败测试。
- 生成的测试要先在本地跑通,别只盯覆盖率数字。
- 信息不足时先提问,不要自行编造数据或事实。
- 脚本只在当前项目目录内运行,运行失败时报告错误原文,不要猜测结果。
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在开发与测试工程师提出相关请求时能对上号;二是约束部分要写进「生成的测试要先在本地跑通,别只盯覆盖率数字」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 在
.github/copilot-instructions.md中写入团队通用约定 - 新建
.github/prompts/bug-repro.prompt.md写入本技能流程 - 在编辑器的 Copilot Chat 中调用该提示文件
- 检查输出是否遵循步骤与格式
- 提交到仓库并在 PR 中说明用途
实操:一次完整的运行
假设你在测试框架与 CI 流水线中发出这样的请求(虚构示例):
用缺陷复现技能处理这份缺陷描述与日志,输出最小复现与失败测试。
智能体识别到任务与「缺陷复现」相关后,会依次提取关键条件、缩小输入、写出失败测试、确认在修复前稳定失败。最终交付最小复现与失败测试,并在末尾列出需要人工确认的内容。你的工作是对照原始缺陷描述与日志抽查两三处关键信息,确认无误后再使用。
测试与验收
在 Copilot Chat 中分别以有、无提示文件的方式处理同一任务,对比差异是否符合预期。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准缺陷描述与日志,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- 仓库级指令写得过细,与提示文件互相矛盾。
- 以为提示文件会自动生效,实际需要手动调用。
- 只写了步骤,没写交付格式,导致每次输出的最小复现与失败测试结构不同。
- 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。
延伸阅读
- 缺陷复现 · Dify 工作流 版
- 缺陷复现 · SKILL.md 写法
- 缺陷复现 · 安全审查
- 无障碍测试 · GitHub Copilot 指令与提示文件 版
- 数据库迁移测试 · GitHub Copilot 指令与提示文件 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。