copilot-instructions.md 怎么写:用途、范例、按路径生效的 instructions 文件与 AGENTS.md 的区别

copilot-instructions.md 是什么、放哪、怎么写?按 GitHub 官方文档讲清仓库级指令、.github/instructions 下按路径生效的 *.instructions.md(applyTo / excludeAgent)、AGENTS.md 三者的分工,附可改写的中文范例与不生效排查。

NNathaniel bigo··原创首发·AI 辅助撰写
8 分钟读完
资料核对于 2026-10-11 · 依据官方文档与公开资料整理 免费账号 账号
本文根据 GitHub 官方文档《Adding repository custom instructions for GitHub Copilot》和《About GitHub Copilot code review》整理,资料核对于 2026-10-11。

适用于谁

  • 想让 Copilot 记住「这个项目怎么构建、怎么测试、有哪些约定」的人;
  • 搜「copilot-instructions.md 范例」「copilot-instructions.md 用途」「copilot-instructions.md vs agents.md」的人;
  • 同时用 Copilot、Cursor、Claude Code,不想维护三份规则的人。

结论先说

  1. .github/copilot-instructions.md 是仓库级的 Copilot 指令:一份 Markdown,保存后自动附加到这个仓库里的 Copilot 请求上。
  2. 想让规则只对某些文件生效,用 .github/instructions/ 下的 名称.instructions.md,在 frontmatter 里用 applyTo 写 glob。
  3. AGENTS.md 是跨工具通用的智能体指令,Copilot 也读;离被处理文件最近的那一份优先。仓库根目录下单独一份 CLAUDE.md 或 GEMINI.md 也可以被当作智能体指令。
  4. 官方一句话分工:copilot-instructions.md 是「Copilot,在这个仓库里始终记住这些」;路径指令是「在这些路径下始终记住这些」;AGENTS.md 是「任何智能体都记住这些」;skills 是「需要时才做这件事」。
  5. 多种指令会同时提供给 Copilot,优先级是:个人指令 > 仓库指令 > 组织指令。尽量别写互相矛盾的内容。

三类文件对照

copilot-instructions.md*.instructions.mdAGENTS.md
位置.github/copilot-instructions.md.github/instructions/**/名称.instructions.md仓库任意位置,可多份
生效方式自动,整个仓库改动的文件匹配 applyTo 时自动自动,最近的一份优先
适合写编码规范、架构默认做法、测试要求某目录 / 某语言 / 某类文件的专门规则希望 Copilot 以外的工具也遵守的约定
谁会读只有 Copilot只有 Copilot支持该约定的各家智能体

写法一:仓库级 copilot-instructions.md

  1. 在仓库根目录建 .github/copilot-instructions.md(没有 .github 目录就新建);
  2. 用自然语言、Markdown 格式写指令。指令之间的空白会被忽略,所以写成一段、每条一行、或用空行隔开都可以。

一份可以直接改写的中文范例:

markdown
# 项目说明
这是一个 Next.js 14 + TypeScript 的电商后台,数据库用 Prisma + MySQL。

## 构建与验证
- 安装依赖:pnpm install(不要用 npm)
- 类型检查:pnpm typecheck;单元测试:pnpm test
- 提交前必须保证以上两条都通过

## 目录
- src/app:页面与路由;src/lib:业务逻辑;prisma/:数据模型
- 不要修改 src/generated/ 下的生成文件

## 约定
- 金额一律用「分」为单位的整数,不用浮点数
- 新接口先写 zod 校验,再写处理逻辑
- 回答和代码注释使用简体中文

官方的建议是让 Copilot 自己生成初稿:在 github.com/copilot/agents 选中仓库,贴上官方提供的「onboard 仓库」提示词,cloud agent 会通读仓库后提交一份 copilot-instructions.md。那段提示词里的两条限制很值得照搬——不超过两页、不写与具体任务相关的内容;目标是让智能体少走弯路:少因为构建或 CI 失败被打回、少花时间到处搜索。在 VS Code 里,登录后在聊天中输入 /init 也能生成起步版本。

写法二:按路径生效的 instructions 文件

  1. 建目录 .github/instructions(可以再分子目录);
  2. 新建文件,文件名必须以 .instructions.md 结尾;
  3. 文件开头写 frontmatter,用 applyTo 指定 glob;多个模式用逗号分隔:
markdown
---
applyTo: "**/*.ts,**/*.tsx"
---
- 组件用具名导出
- 不使用 any;确实需要时写明原因

常用 glob:**/.py 递归匹配所有目录下的 py 文件;src/.py 只匹配 src 目录这一层;src/**/*.py 递归匹配 src 下所有层级。

  1. 可选:用 excludeAgent 让某个功能不读这份文件,取值 "code-review" 或 "cloud-agent":
markdown
---
applyTo: "**"
excludeAgent: "code-review"
---

上面这份只给 cloud agent 用。不写 excludeAgent 时,代码审查和 cloud agent 都会用。官方注明:在 GitHub.com 上,路径指令目前只有 cloud agent 和代码审查支持。

当某个文件同时命中路径指令和仓库级指令时,两份都会用上。

写法三:AGENTS.md

可以在仓库里放一份或多份 AGENTS.md。Copilot 工作时,目录树里离得最近的那份优先。适合放「换任何工具都成立」的内容:怎么装依赖、怎么跑测试、目录结构、提交规范。跨工具共用的详细做法见《AGENTS.md 怎么写》;Claude Code 这边的写法见《CLAUDE.md 怎么写》。

一个实用的分法:通用约定写进 AGENTS.md,只有 Copilot 才需要的(比如代码审查的关注点)写进 copilot-instructions.md,避免同一句话维护两遍。

怎么确认生效了

  • 指令文件一保存就可用,会自动加进你提交给 Copilot 的请求;
  • 在 github.com/copilot 的聊天里,把包含指令文件的仓库作为附件加入对话;
  • 展开回答顶部的 References(引用)列表,看里面有没有 .github/copilot-instructions.md——列出来了就说明这次用上了。

常见问题

Q:代码审查没按我的指令来?

代码审查默认启用自定义指令,但可以在仓库 Settings → Copilot → Code review 里被关掉,检查「Use custom instructions when reviewing pull requests」开关。另外官方说明:审查 PR 时读的是源分支(head)上的指令文件,所以可以在同一个 PR 里改指令并立刻看到效果。

Q:写多长合适?

官方给 cloud agent 的生成提示词限制在两页以内。越长占用上下文越多,也越容易自相矛盾。

Q:个人偏好(比如总是用中文回答)写哪?

写个人指令(personal instructions),它优先级最高,而且不会影响同事。

Q:回答质量变差,怀疑是指令冲突?

官方建议尽量避免冲突的指令;排查时可以临时关闭仓库指令对比效果。

参考资料

  • Adding repository custom instructions for GitHub Copilot(GitHub 官方):https://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/add-custom-instructions/add-repository-instructions
  • Adding repository custom instructions in your IDE(GitHub 官方):https://docs.github.com/en/copilot/how-tos/copilot-in-your-ide/customize-copilot/configure-custom-instructions/add-repository-instructions-in-your-ide
  • About GitHub Copilot code review(GitHub 官方,含四类定制方式对照表):https://docs.github.com/en/copilot/concepts/agents/code-review
  • agentsmd/agents.md 仓库:https://github.com/agentsmd/agents.md

Nathaniel 的更多内容

  1. 01

    MCP 的 stdio、SSE 和 Streamable HTTP 有什么区别:本地与远程 MCP 怎么选

    MCP 配置里的 stdio、sse、http 到底差在哪?按 MCP 官方规范讲清两种标准传输方式的工作原理、Streamable HTTP 与旧的 HTTP+SSE 的关系、会话与断线续传、规范对安全的硬性要求,以及本地服务器和远程服务器各适合什么场景。

    Claude其他 AI 工具0
  2. 02

    Midjourney 可以商用吗:作品归属、商用条件与隐身模式

    Midjourney 生成的图片和视频能不能商用、版权归谁、公司用要什么套餐、作品会不会被别人看到?本文按 Midjourney 服务条款逐条解释,并补充中美对 AI 生成图片版权的官方 / 司法观点。

    其他 AI 工具0
  3. 03

    扣子智能体怎么发布:飞书、微信公众号、小程序、API 等渠道步骤与审核

    扣子智能体怎么发布到飞书、微信公众号、小程序或做成 API?本文按扣子官方文档讲清有哪些发布渠道、打包与两轮审核的流程、首次发布 1–7 个工作日的审核时间、各渠道功能差异,以及发布到豆包这类问题官方文档目前怎么写。

    其他 AI 工具0
  4. 04

    Gemini API Python 调用教程:安装 google-genai SDK、流式输出、多轮对话与传图片

    用官方 google-genai SDK 调 Gemini API:安装配置、第一个请求、系统指令与思考等级、流式输出、多轮对话、传图片和查看 token 用量,按 2026 年 10 月官方默认的 Interactions API 写法。

    Gemini0
  5. 05

    Claude Code Subagents(子代理)怎么用:创建、调用与最佳实践

    Claude Code 子代理是在独立上下文里干活、只交回摘要的专用助手。本文讲内置子代理、怎么创建(.claude/agents)、frontmatter 字段、三种调用方式、指定模型和常见用法。

    Claude0
  6. 06

    ChatGPT 搜索怎么用:联网搜索、查看来源与结果不准怎么办

    ChatGPT 能联网搜索最新信息并附上来源链接。本文按官方帮助中心讲清怎么手动开启搜索、怎么看引用来源、本地结果不准的原因(位置设置)、搜索按钮不见了怎么排查,以及什么时候该用深度研究。

    ChatGPT0

同产品的其他教程

  1. 01

    GitHub Copilot CLI 安装与使用:npm / winget / brew 安装、登录、常用指令与工具权限

    GitHub Copilot CLI 怎么安装、怎么用?按官方文档讲清三种安装方式(npm 需 Node.js 22+)、/login 登录与令牌登录、交互模式常用快捷键、copilot -p 非交互调用,以及 --allow-tool / --deny-tool 工具权限的写法。

    GitHub Copilot0
  2. 02

    用 AI 读代码:快速看懂陌生代码库的提问顺序与 20 个可复制问题

    接手陌生项目怎么用 AI 读代码?按 GitHub Copilot 与 Cursor 官方教程整理出从整体到细节的五轮提问:项目概览、入口与构建、数据流、定位具体功能、画架构图;讲清精确搜索与按含义搜索的区别,附 20 个可复制的问题。

    GitHub Copilot其他 AI 工具0
  3. 03

    GitHub Copilot Code Review 怎么用:PR 里请求审查、自动审查、审查力度与自定义指令

    GitHub Copilot 代码审查教程:在 PR 的 Reviewers 里点 Request、应用建议与 Fix with Copilot、开启自动审查、Lite / Balanced 两档审查力度、用 instructions 定制审查重点、哪些文件不审,以及计费方式,按 GitHub 官方文档整理。

    GitHub Copilot0
  4. 04

    Copilot Skills 是什么、怎么用:VS Code 里的 Agent Skills 目录、字段与调用

    GitHub Copilot 的 Skills 放在哪个文件夹、怎么创建和调用?按 VS Code 官方文档讲清 .github/skills 等六个技能目录、SKILL.md 的字段、/ 斜杠调用与自动加载的四种组合、和自定义指令的区别,以及使用别人分享的技能前要做的检查。

    GitHub Copilot0
  5. 05

    GitHub Copilot 学生认证怎么申请:GitHub Education 条件、材料、激活 Copilot Student 与常见卡点

    GitHub Copilot 学生认证官方流程:谁有资格、要准备什么证明材料、学校邮箱的三种情况、在 Education benefits 页提交申请、通过后怎么激活 Copilot Student、它和 Pro 的区别,以及通过了却仍显示 Free 或付费页时怎么办。

    GitHub Copilot0
  6. 06

    GitHub Copilot 在 IDEA / PyCharm 里怎么用:JetBrains 插件安装、登录与 Agent 模式

    IDEA 安装 GitHub Copilot 教程:支持哪些 JetBrains IDE、在插件市场安装、用设备码登录 GitHub、打开 Chat 和 Agent 模式、接 MCP,以及登录失败、看不到 Agent 选项等常见问题,按 GitHub 官方文档整理。

    GitHub Copilot0

0 条评论

登录 后参与评论

还没有评论,来抢沙发~