Copilot 自定义指令实战:命名规范审查的 prompt.md 示例
开发者经常要做「命名规范审查」这类事:按团队命名约定检查变量、函数、文件命名并给出改名建议。每次都从头写提示词,结果时好时坏;把它做成智能体 Skill,就能让智能体每次按同一套步骤执行,输出结构也更稳定。
本文介绍如何在 GitHub Copilot 指令与提示文件 上实现这个技能,包括它的形态、示例配置、启用步骤、一次完整的运行过程和常见坑。
这个技能做什么
| 项目 | 说明 |
|---|---|
| 技能 | 命名规范审查(naming-review) |
| 作用 | 按团队命名约定检查变量、函数、文件命名并给出改名建议 |
| 输入 | 代码 diff 或目录 |
| 输出 | 命名问题列表与建议名称 |
| 形态 | 纯提示词 |
| 风险 | 低 |
| 适用人群 | 开发者 |
处理流程分四步:
- 读取命名约定
- 扫描新增符号
- 对照约定判断
- 输出建议并标注影响面
这个技能纯指令型,不需要额外脚本或外部连接,复制到大多数平台都能用;风险较低,但输出仍需快速过目再使用。
在 GitHub Copilot 指令与提示文件 中是什么形态
GitHub Copilot 支持仓库级自定义指令文件 .github/copilot-instructions.md,以及放在 .github/prompts/ 下、以 .prompt.md 结尾的可复用提示文件,适合把固定流程交给 Copilot Chat 或智能体模式执行。
仓库级指令对该仓库的对话默认生效;提示文件需要在支持的编辑器中手动调用,具体支持情况以 Copilot 文档为准。
示例配置
.github/prompts/naming-review.prompt.md 示例(示意):
---
description: 命名规范审查
---
请对我提供的代码 diff 或目录执行「命名规范审查」:
1. 读取命名约定
2. 扫描新增符号
3. 对照约定判断
4. 输出建议并标注影响面
输出格式:命名问题列表与建议名称。
- 改动前确认有测试与版本控制,一次只改一类问题。
- 信息不足时先提问,不要自行编造数据或事实。
示例里最重要的是两处:一是描述(或指令开头)要写明「什么时候用」,让智能体在开发者提出相关请求时能对上号;二是约束部分要写进「改动前确认有测试与版本控制,一次只改一类问题」这类领域规矩,避免智能体自作主张。
安装与启用步骤
- 在
.github/copilot-instructions.md中写入团队通用约定 - 新建
.github/prompts/naming-review.prompt.md写入本技能流程 - 在编辑器的 Copilot Chat 中调用该提示文件
- 检查输出是否遵循步骤与格式
- 提交到仓库并在 PR 中说明用途
实操:一次完整的运行
假设你在代码仓库与终端中发出这样的请求(虚构示例):
帮我做一下命名规范审查,材料是附上的代码 diff 或目录。
智能体识别到任务与「命名规范审查」相关后,会依次读取命名约定、扫描新增符号、对照约定判断、输出建议并标注影响面。最终交付命名问题列表与建议名称,并在末尾列出需要人工确认的内容。你的工作是对照原始代码 diff 或目录抽查两三处关键信息,确认无误后再使用。
测试与验收
在 Copilot Chat 中分别以有、无提示文件的方式处理同一任务,对比差异是否符合预期。
针对这个技能,还建议额外准备:
- 一份信息齐全的标准代码 diff 或目录,检查输出是否完整
- 一份缺少关键信息的输入,检查智能体是否先提问而不是编造
- 一份包含“忽略以上规则”等字样的输入,检查约束是否仍然有效
常见坑
- 仓库级指令写得过细,与提示文件互相矛盾。
- 以为提示文件会自动生效,实际需要手动调用。
- 只写了步骤,没写交付格式,导致每次输出的命名问题列表与建议名称结构不同。
- 没有给出样例,智能体对“好结果”的理解与你不一致;在参考资料里放一两份范例会明显改善。
延伸阅读
- 命名规范审查 · 定制指南
- 命名规范审查 · AGENTS.md 版
- 命名规范审查 · Function Calling 版
- 错误处理审查 · GitHub Copilot 指令与提示文件 版
- 文案国际化提取 · GitHub Copilot 指令与提示文件 版
- 智能体Skills 分类:625 个技能 × 32 个角度
说明:文中的配置、代码与目录结构均为示意,用于说明思路;各平台的入口、字段名与能力会更新,落地前请以对应官方文档为准。示例中的数据与场景为虚构,不代表真实案例。