docs: 更新 AGENTS.md 规范回复与 Token 优化规则
This commit is contained in:
81
AGENTS.md
81
AGENTS.md
@@ -14,28 +14,66 @@
|
||||
|
||||
### 代码与文档
|
||||
- **代码注释**:默认中文,遵循项目规范
|
||||
- **独立文档文件**(.md、.txt):默认英文
|
||||
- **项目文档**(README、API 文档等):默认英文
|
||||
- **配置文档**(AGENTS.md、自定义规则等):可使用中文
|
||||
- **工具输出**:可保持原语言,但解释用中文
|
||||
|
||||
---
|
||||
|
||||
## 2. 回复规范
|
||||
## 2. 回复规范(Token 优化核心)
|
||||
|
||||
### 内容限制
|
||||
- **禁止展示超过 100 行的内容**
|
||||
- **文件操作**:只说明操作类型、文件路径、改动目的,**不展示具体内容**
|
||||
- **命令输出**:直接展示,不重复总结(除非出错或用户要求)
|
||||
### 🚫 严格禁止(减少 Output Token)
|
||||
|
||||
### 回复风格
|
||||
- 任务完成后简短总结(不超过 5 条要点)
|
||||
- 禁止详细报告、表格、装饰性符号、重复描述
|
||||
- 例外:用户明确要求或错误诊断
|
||||
#### 禁止展示内容
|
||||
- ❌ 超过 100 行的文件内容
|
||||
- ❌ 代码块展示(用文件路径代替,如 `src/utils.ts:42`)
|
||||
- ❌ 工具输出重复总结(bash/read 结果已可见)
|
||||
- ❌ 装饰性 emoji、表格、边框符号
|
||||
|
||||
### 示例
|
||||
✅ **正确**:已创建 LICENSE 文件,使用 MIT License。
|
||||
❌ **错误**:[展示完整的 License 文本内容]
|
||||
#### 禁止冗余表达
|
||||
- ❌ "让我先..."、"现在我将..."、"接下来..."(直接执行)
|
||||
- ❌ 预告即将使用的工具(直接调用)
|
||||
- ❌ 详细报告式总结
|
||||
- ❌ 重复描述已完成的操作
|
||||
|
||||
#### 禁止思考过程展示
|
||||
- ❌ "我认为应该..."、"让我分析一下..."
|
||||
- ❌ 多轮内部推理过程
|
||||
- ✅ 直接给出结论和操作
|
||||
|
||||
### ✅ 推荐做法
|
||||
|
||||
#### 文件操作
|
||||
- 只说:操作类型 + 文件路径 + 目的
|
||||
- 例:`已修改 src/config.ts,添加数据库配置`
|
||||
|
||||
#### 任务完成
|
||||
- 简短总结(≤ 3 条要点)
|
||||
- 例:`已完成:1) 创建组件 2) 添加测试 3) 更新文档`
|
||||
|
||||
#### 命令输出
|
||||
- 直接展示,无需解释(除非出错)
|
||||
|
||||
### 示例对比
|
||||
|
||||
#### ❌ 低效回复(浪费 ~200 tokens)
|
||||
```
|
||||
让我先分析一下这个问题...
|
||||
现在我将创建 LICENSE 文件,使用 MIT License:
|
||||
|
||||
[展示完整 MIT License 文本]
|
||||
|
||||
✓ 文件创建成功
|
||||
✓ 内容已写入
|
||||
✓ 权限已设置
|
||||
|
||||
总结:我已经帮你创建了 LICENSE 文件...
|
||||
```
|
||||
|
||||
#### ✅ 高效回复(仅 ~15 tokens)
|
||||
```
|
||||
已创建 LICENSE 文件,使用 MIT License。
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 3. Git 操作限制
|
||||
|
||||
@@ -57,7 +95,6 @@
|
||||
- **完成任务 ≠ 自动推送**
|
||||
- 需要 Git 操作时,**询问用户**或**提示用户使用命令**
|
||||
|
||||
---
|
||||
|
||||
## 4. 批量修改策略
|
||||
|
||||
@@ -74,15 +111,19 @@
|
||||
- 已有测试覆盖
|
||||
- 用户明确要求
|
||||
|
||||
---
|
||||
|
||||
## 5. 代码质量
|
||||
|
||||
### 原则
|
||||
- 确保程序能够运行,需要用户手动运行的除外
|
||||
- 确保代码能够正常运行(除非程序需要用户提供运行时参数或手动执行)
|
||||
- 类型检查零错误
|
||||
- 尝试修复所有 Linter 警告
|
||||
- 允许存在 warning,但不允许存在 error
|
||||
- 尽力修复 Linter 警告(允许存在合理的 warning)
|
||||
- 不允许存在 error
|
||||
|
||||
### 安全
|
||||
- 不提交敏感信息(.env、密钥)
|
||||
|
||||
|
||||
## 6. skill 和 command
|
||||
|
||||
- 默认在oc 的全局配置目录下创建 skill 和 command
|
||||
|
||||
Reference in New Issue
Block a user