跳到主要内容

全局规范

CLAUDE.md、AGENTS.md规范文件文件建议提交到 Git 仓库。

  • AGENTS.md 属于仓库级工程规范,和 README、CONTRIBUTING 类似
  • 提交后团队成员与各类 Agent 都能拿到一致规则,减少“每次口头重复说明”。
  • 变更可追溯(谁改了规范、为什么改),便于协作和审计。
  • 用于定义规范、约束、让模型理解项目整体的架构情况,给模型看的项目说明书 / 行为规则文件

生成规范文件​

统一通过 /init 生成两种规范文件:

  • CLAUDE.md(Claude Code 全局规范)
  • AGENTS.md(OpenCode 规范)
  • Claude Code、OpenCode,统一通过/init命令来生成
  • /init命令默认是英文内容来生成,可以用中文来生成
bash
# 生成的规范用中文
/init 生成内容请使用中文

规范文件模板​

  • CLAUDE.md、AGENTS.md
claude
# 全局规范

> 本文件用于约束 **Claude Code / Claude Code Router / 多模型** 的统一行为。
> 所有进入本仓库的 AI Agent **必须遵守以下规则**。

---

## 一、语言与输出规范(最高优先级)

### 1.1 默认语言

* **所有回复必须使用简体中文**
* 包括但不限于:

* 问题分析
* 设计说明
* 执行计划(Plan)
* 代码解释
* Git 提交说明

> ❗ 除非用户明确要求英文,否则 **禁止使用英文回答**。

---

### 1.2 代码相关语言规范

* **代码本身**:

* 变量名 / 函数名 / API 名称 → 使用英文
* **代码注释**:

* 必须使用简体中文
* 禁止新增英文注释

示例:

```ts
// 正确:获取用户信息
function getUserInfo() {}

// 错误:Get user info
```

---

## 二、工作模式规范(Plan / 执行)

### 2.1 Plan 模式(规划优先)

在以下场景 **必须先进入 Plan 模式**,不得直接修改代码:

* 涉及 **3 个及以上文件** 的修改
* 架构调整 / 模块拆分
* 不熟悉的代码仓库
* 用户明确表示需要“方案 / 设计 / 思路”

Plan 模式要求:

* 只输出:

* 实现步骤
* 涉及文件
* 潜在风险
* **禁止**:

* 修改代码
* 输出 diff
* 执行命令

---

### 2.2 执行模式(允许改代码)

只有在以下情况才允许进入执行模式:

* 用户明确同意,例如:

* “按计划执行”
* “可以直接修改代码”
* “开始实现”

执行模式要求:

* 修改范围应尽量小
* 遵循现有代码风格
* 修改后逻辑必须自洽

---

## 三、代码修改原则(强约束)

### 3.1 最小改动原则

* 不做与目标无关的重构
* 不随意改动已有 API 行为
* 不引入未使用的依赖

---

### 3.2 安全与谨慎

* 这是生产级代码,修改需保持谨慎
* 对不确定的地方:

* 优先提出问题
* 或在 Plan 中标注风险

---

### 3.3 输出形式

* 当修改代码时:

* 优先使用 **diff / patch** 形式
* 当用户要求“只给结果”:

* 不输出多余解释

---

## 四、多模型协作规范(通用,不限定具体模型)

### 4.1 模型无关原则

* 本仓库 **不假设也不限定任何具体大模型**
* 可能使用的模型包括但不限于:

* Claude 系列
* Qwen 系列
* Gemini 系列
* OpenAI / xAI / DeepSeek / Mistral / Llama 等

👉 **无论底层使用何种模型,都必须严格遵守本 CLAUDE.md 的全部规范**。

---

### 4.2 行为一致性要求

* 模型差异 **不应影响**:

* 输出语言(必须为简体中文)
* 是否先进入 Plan 模式
* 代码修改的谨慎程度
* 注释与说明规范

* 当模型能力不足以完成任务时:

* 应明确说明限制
* 不得臆造结果或代码

---

### 4.2 模型能力偏好(参考)

* **Qwen**:

* 中文项目
* 前端 / Node / Vue / Nuxt
* 批量代码修改

* **Gemini**:

* 架构分析
* 长上下文理解
* 文档型仓库

* **Claude**:

* 高风险重构
* 精细代码调整

> 模型切换不应影响输出语言和规范。

---

## 五、上下文与会话规范

### 5.1 会话假设

* 默认认为:

* 当前会话是 **全新上下文**
* 不主动引用历史对话内容

---

### 5.2 不确定即确认

在以下情况必须先确认,而不是擅自修改:

* 需求描述模糊
* 代码意图不明确
* 可能影响核心逻辑

---

## 六、推荐的标准工作流

### 6.1 标准流程

1. 进入 Plan 模式
2. 输出清晰步骤
3. 等待用户确认
4. 分步骤执行

---

### 6.2 快速修复流程(小改动)

* 明确问题 → 直接修改
* 保持改动最小
* 注释说明原因(中文)

---

## 七、禁止事项(红线)

* ❌ 未经允许修改大量文件
* ❌ 擅自改变既有行为
* ❌ 输出英文解释或英文注释
* ❌ 编造不存在的文件或 API

---

## 八、最终原则

> **清晰 > 聪明**
> **稳定 > 炫技**
> **中文优先,计划优先,谨慎执行**

---

(本文件为最高优先级约束,适用于所有 AI Agent)