GitHub Copilot 自定义指令配置指南
GitHub Copilot 是个强大的 AI 编程助手,但要想让它真正懂你的项目,光靠默认设置还不够。合理配置自定义指令,能让它更好地遵循团队编码规范,省去每次提问时重复输入提示语的麻烦。
方法一:项目级别指令文件(推荐)
这是最推荐的方式,因为文件随代码库版本控制,团队成员都能共享同一套规范。
创建 .github/.copilot-instructions.md
在项目根目录创建此文件。如果还没有 .github 目录,就先建一个。Copilot 会自动读取并作为上下文参考。
你可以在 VS Code 中搜索相关选项来确认配置是否生效,通常路径如下:

文件内容示例
这里可以定义通用的编程规范,比如函数命名、布尔值前缀等:
# Copilot 代码规范
## 通用编程规范
### 函数命名规范
- 使用驼峰命名法(camelCase)
- 函数名应该是动词或动词短语
- 布尔值返回的函数使用 is/has/can 前缀
#### 示例
```javascript
// ✅ 正确
function calculateTotalPrice(items) {}
function isUserLoggedIn() {}
function hasPermission(user, action) {}
// ❌ 错误
function price(items) {}
function userLogin() {}
如果是团队规范,可以补充组件开发和 API 调用的约定:
```markdown
### 组件开发规范
- React/Vue 组件使用 PascalCase 命名
- 组件文件名与组件名保持一致
- Props 使用 TypeScript 类型定义
### API 调用规范
- 使用 async/await 而不是 Promise.then()
- 统一错误处理机制
- 请求参数使用 TypeScript 接口定义
### Git Commit 消息格式
<type>(<scope>): <subject>
针对特定技术栈也可以单独写一份,比如 Vue.js 项目:
# Vue.js 项目指令
## 组件开发规范
- 使用 Composition API 优于 Options API
- 组件 props 必须定义 TypeScript 类型
- 事件命名使用 kebab-case
## 状态管理
- 使用 Pinia 进行状态管理
- Store 模块按功能划分


