docs: 补充README中.github Copilot指令与模板配置说明
This commit is contained in:
46
README.md
46
README.md
@@ -63,6 +63,52 @@
|
||||
3. **动态绑定规范**:AI 会根据指令中的 `@` 语法,自动去读取 `02` 到 `05` 目录下的具体规范(如 API 规范、Python 规范),确保生成的代码 100% 符合团队红线。
|
||||
4. **架构决策 (ADR)**:当 AI 发现技术分歧并向你提问时,做出选择,AI 会自动在 `01 - Knowledge & Prompts/Architecture Decision Records/` 下生成 ADR 文档。
|
||||
|
||||
### **1.1 🤖 仅使用 `.github` 的 Copilot 自定义配置(推荐)**
|
||||
|
||||
如果你希望不再手动“添加上下文”,而是让 Copilot 自动加载团队规则,请统一使用仓库根目录下的 `.github/` 自定义资产。
|
||||
|
||||
**目录约定:**
|
||||
|
||||
```text
|
||||
.github/
|
||||
copilot-instructions.md
|
||||
instructions/
|
||||
*.instructions.md
|
||||
prompts/
|
||||
*.prompt.md
|
||||
```
|
||||
|
||||
**三类文件职责:**
|
||||
1. `copilot-instructions.md`:全局常驻规则(例如中文输出、决策点询问、ADR 先行、提交规范)。
|
||||
2. `instructions/*.instructions.md`:按文件匹配自动注入的规范(通过 `applyTo` 控制作用范围)。
|
||||
3. `prompts/*.prompt.md`:按阶段显式调用的任务模板(如蓝图、设计、编码、测试、审查、部署、重构)。
|
||||
|
||||
**Prompt Frontmatter 关键要求:**
|
||||
1. 使用 `agent:` 字段,不再使用已弃用的 `mode:` 字段。
|
||||
2. 必须提供 `description:`,并写入清晰关键词,便于 Copilot 发现与匹配。
|
||||
|
||||
示例:
|
||||
|
||||
```yaml
|
||||
---
|
||||
agent: agent
|
||||
description: "用于生成核心业务代码;关键词:Fat Service、OpenAPI、统一响应"
|
||||
---
|
||||
```
|
||||
|
||||
**落地步骤:**
|
||||
1. 在 `.github/copilot-instructions.md` 写入 P0 全局纪律。
|
||||
2. 在 `.github/prompts/` 放置 P1-P8 阶段模板。
|
||||
3. 在 `.github/instructions/` 放置规范文件,并配置精确 `applyTo`(避免使用过宽模式导致上下文噪音)。
|
||||
4. 在 Copilot Chat 中直接调用对应 Prompt,日常无需再手动追加全局上下文。
|
||||
|
||||
**排错清单(无效时优先检查):**
|
||||
1. frontmatter 是否使用 `---` 成对包裹。
|
||||
2. Prompt 是否使用了 `agent:` 而不是 `mode:`。
|
||||
3. `description` 是否包含可检索关键词。
|
||||
4. `applyTo` 是否匹配了当前编辑文件路径。
|
||||
5. 文件是否位于仓库根目录 `.github/` 下(而非其他目录)。
|
||||
|
||||
### **2. 🏢 新员工入职与人工查阅**
|
||||
|
||||
1. **快速上手**:请优先阅读 `03 - Coding & Frameworks` 目录下的相关语言与框架规范,确保首个提交符合团队红线。
|
||||
|
||||
Reference in New Issue
Block a user