IDE 仓库与个人指令
创建项目指令、配置各编辑器入口,并核对实际加载与支持范围。
This page has not been translated into English yet. The original Chinese version is shown below.
Custom instructions 用于保存项目约定、构建测试方法和实现要求,减少重复提示。通用仓库文件是 .github/copilot-instructions.md;保存后由支持的 Copilot 功能自动加入请求。具体类型支持随 IDE、功能和会话运行方式变化。
创建仓库指令
在仓库根目录的 .github 下创建 copilot-instructions.md,用 Markdown 写出与项目实际情况一致的说明。没有强制的正文段落格式,可以分段或列点。
例如,说明代码应放在哪些目录、哪些文件由工具生成、怎样运行项目已有验证。命令需要先在仓库核实,不能把其他项目的测试命令原样当作本项目要求。
各 IDE 的入口
| 编辑器 | 设置或创建方式 |
|---|---|
| VS Code | GitHub 教程在 Settings 搜索 instruction file,切换 Code Generation: Use Instruction Files;当前 VS Code 还需区分 Local 与 Agent Host |
| Visual Studio | Tools → Options 搜索 custom instructions,切换从 .github/copilot-instructions.md 加载指令的选项,默认开启 |
| JetBrains | Settings → Tools → GitHub Copilot → Customizations,在 Copilot Instructions 选择 Workspace 或 Global |
| Xcode | Copilot 应用 → Settings → Advanced,在 Custom Instructions 选择 Current Workspace 或 Global |
| Eclipse | Copilot → Edit preferences → GitHub Copilot → Custom Instructions,启用 Enable workspace instructions;项目指令仍可放入 .github 文件 |
Eclipse 的该功能在教程中仍标为 public preview。VS Code / Visual Studio 的个人 Chat 开关不影响其他用户,也不等于 GitHub 仓库代码审查的设置。
JetBrains 全局文件
官方给出以下全局文件位置,YOUR-USERNAME 替换成真实用户名:
| 系统 | 路径 |
|---|---|
| macOS | /Users/YOUR-USERNAME/.config/github-copilot/intellij/global-copilot-instructions.md |
| Windows | C:\Users\YOUR-USERNAME\AppData\Local\github-copilot\intellij\global-copilot-instructions.md |
该页没有给出 Linux 的对应路径,不从其他客户端目录推导。可使用 IDE 中的 Global 入口管理。
当前支持矩阵
GitHub 的专门支持参考列出:VS Code Chat 支持仓库、路径和 AGENTS.md 指令;Visual Studio、JetBrains、Xcode Chat 支持仓库和路径指令;Eclipse Chat 列出仓库指令。
JetBrains、Xcode 的创建教程仍称只有单个仓库文件,而支持参考已列出路径指令。两处不同,本页保留差异;路径文件结构见路径指令。
VS Code 的会话范围
当前 VS Code 文档区分 Agent Host 与 Local agent:前者按所选 agent harness 发现指令,后者使用 VS Code 的相关设置。自定义指令不用于输入时的行内补全。不要把 GitHub 通用教程的一个开关理解成所有 VS Code 会话都适用。
验证加载
在 Chat 回答的 References 中检查是否出现 .github/copilot-instructions.md。文件已被发现或列为引用,不等于模型完全遵循;还要检查输出是否满足约定。
GitHub 仓库的 Settings → Copilot → Code review → Use custom instructions when reviewing pull requests 控制该仓库 PR 审查的指令使用,与个人 IDE 的 Chat 开关分开。