SuperAPI AI 工具集

make-instructions

办公与效率

查看项目

更新于 10-15 21:12

技能介绍

用途:该技能帮助你搭建 VS Code 基于文件的指令(.instructions.md),为 Copilot 提供代码库中特定部分的背景知识。这些文件会根据 glob 模式或语义匹配自动应用,使 Copilot 在处理匹配文件时获得领域上下文。

主要能力与不适用场景:适用于创建、搭建或添加文件级指令。若需项目级指令,应使用 .github/copilot-instructions.md 或 AGENTS.md;若需可复用的结构化智能体工作流,或需要按需调用的指令,应使用 Agent Skills。

使用方式:

  1. 调研主题:确定适用的文件或文件模式、关键约定、常见陷阱、代码中无法直接发现的领域知识;阅读同一路径下已有的仓库级指令并建立排除清单,避免重复。范围不清或与现有指令重叠时向用户确认。
  2. 选择位置:默认放在 .github/instructions/,使用描述性文件名,如 .github/instructions/<topic>.instructions.md。
  3. 生成带 YAML frontmatter 的文件,frontmatter 可含 name(可选,显示名)、description(可选,悬停显示并用于语义匹配)、applyTo(可选,相对工作区根目录的 glob)。常见 applyTo 如 /*.cs、test/。
  4. 编写正文:简洁、具体、可执行的 Markdown;包含简短代码示例说明推荐与避免的写法;解释非显而易见规则的原因;跳过 linter 已覆盖的规则;用 Markdown 链接引用文件或 URL。推荐章节包括标题、上下文段落、指南/约定、示例、关键文件、常见陷阱。
  5. 编写并验证评测:创建 eng/harness-evaluation/instructions/<id>/eval.yaml,其中 <id> 为 .github/instructions/ 下的指令路径去掉后缀并把嵌套路径分隔符替换为 --。遵循 eng/harness-evaluation/README.md 的规则。

验证要点:文件位于 .github/instructions/(或配置的指令文件夹);文件名以 .instructions.md 结尾且仅含小写字母、数字和连字符;YAML frontmatter 有效;applyTo 匹配目标文件;内容简洁(建议少于 500 行或 5000 token);不含密钥、令牌或内部 URL;不与 .github/copilot-instructions.md 或 .agents/skills/ 重复;配对评测能证明省略指令的对照组无法可靠提供该行为。

限制:applyTo 过宽会浪费上下文,缺失 applyTo 则不会自动应用而需手动附加或语义匹配;指导要具体,避免笼统表述。资料未提供收费、价格、平台等更多信息。