Skip to content
FunCoding

Search

Search docs, Skills and MCP

GitHub 仓库指令

配置仓库通用、路径专用与 Agent 指令,并检查网页 Chat 和 PR review 的加载。

This page has not been translated into English yet. The original Chinese version is shown below.

把项目结构、构建步骤和验证要求写入仓库,可以减少每次任务重新解释。GitHub 上的不同功能支持不同指令类型,路径正确并不等于所有入口都会读取。

文件类型与范围

类型位置规则
仓库通用.github/copilot-instructions.md针对仓库上下文提供 Markdown 自然语言要求
路径专用.github/instructions/NAME.instructions.md,可放子目录frontmatter 的 applyTo 匹配相关文件时加入
Agent 指令仓库任意位置的 AGENTS.md本页说明目录树中最近的文件优先
其他 Agent 文件根目录单个 CLAUDE.md 或 GEMINI.md作为官方列出的另一种 Agent 指令入口

GitHub.com 的路径专用指令当前只支持 cloud agent 和 code review。匹配时会同时使用路径专用与仓库通用规则,不是二选一。其他客户端的范围见自定义与扩展,不要将本页的 Agent 文件优先级套用到 CLI 的全部指令文件。

路径匹配和排除某个 Agent

例如,仅让 cloud agent 使用以下规则:

---
applyTo: "**/*.ts,**/*.tsx"
excludeAgent: "code-review"
---

Use the project's documented TypeScript validation steps.

applyTo 用 glob,多个模式以逗号分隔。src/*.py 只匹配该目录直接包含的 Python 文件;src/**/*.py 可递归匹配。** 或 **/* 可匹配全部目录中的文件。

excludeAgent 可填 code-review 或 cloud-agent,阻止相应功能读取;省略时两者都会使用适用规则。这是指令读取控制,不能作为 Agent 工具权限或访问沙箱。

生成与检查仓库通用指令

可以自行创建 .github/copilot-instructions.md,也可在 GitHub 的 Agents 页面选择仓库,让 cloud agent 调查项目并通过 draft PR 提议指令文件。重点应包括真实可运行的构建、测试顺序、环境前提、关键配置位置和已知失败条件。生成内容仍需要核对后再接受。

网页 Chat 中附加包含该文件的仓库,然后检查回答的 References:使用了仓库通用指令时,应能找到 .github/copilot-instructions.md 并点击打开。官方网页操作说明保存文件后即可供请求使用;这不是 CLI 活动会话无需刷新的承诺。

Code review 的专门设置

仓库 Settings → Copilot → Code review → Use custom instructions when reviewing pull requests 默认开启。关闭或重新开启会影响 Copilot 在该仓库执行的所有 code reviews。

PR review 从 head branch 读取仓库指令、Agent 指令和 Skills。因此可以在同一 PR 中测试指令变更,不必先合入 base branch。评审时也应注意 PR 本身是否修改了这些规则;具体限制见代码审查自定义。

建立项目的完整上下文

官方项目快速上手把仓库指令、专门角色与Spaces组合使用:先核实项目的构建和约定,再创建适合重复任务的角色,最后把架构文档、API schema及相关Issues整理进Space。该流程需付费Copilot、已启用cloud agent和仓库写权限。配置各有作用域,不能用Space代替仓库的验证命令或角色工具范围。