Skip to content

推荐全局规则

为了让 Codex、Claude Code、Cursor 等 AI 编程助手更加规范地修改代码、减少无关改动并自动遵循测试规程,我们建议在项目的根目录下创建一个名为 AGENTS.mdCLAUDE.md 的规范文件。

AI 助手在启动时会自动读取并遵循这些规则。


1. 设计思想:渐进式 Spec

在开始修改代码之前,AI 助手应当根据任务规模遵循不同的规程:

  • 简单任务(如:修改字段、修小 bug):可以直接阅读相关文件,修改并进行最小化验证。
  • 中等任务(如:重构组件、跨多处修改):先列出轻量计划,指明影响面,经用户确认后再编码。
  • 复杂任务(如:跨模块、多系统对接):先编写完整的技术Spec,拆分步骤,分段实现并逐步验证。

2. 规则模板全文

复制以下内容,在您的项目根目录下新建一个 AGENTS.mdCLAUDE.md 文件并保存:

markdown
# AI 编程助手开发规范

## 工作原则
- **先读后写**:在提出代码修改建议前,必须先阅读相关的源文件和项目架构。
- **改动收敛**:保持修改范围聚焦于请求的任务,严禁进行大范围无关重构或全局格式化。
- **尊重用户修改**:如果用户已经做出了局部修改,在合并时必须尊重并整合这些手动修改。
- **风险提前说明**:对于高风险的改动(如修改数据库结构、升级关键核心依赖),需要先向用户阐明潜在副作用。

## TopRouter 连接边界
- 所有 TopRouter API 连接必须使用 Base URL: `https://toprouter.cc` (切勿在末尾附加 `/v1`)。
- 严禁将 TopRouter 的 API Key 硬编码在代码文件、配置文件或日志中。必须使用环境变量读取。

## 验证与提交流程
- **执行本地测试**:在代码修改完成后,尽可能运行本地的测试套件(如 Jest, PyTest 等)验证正确性。
- **多端视口检查**:在修改前端界面时,至少检查桌面端和移动端的主要视口排版是否正常。
- **失败说明**:如果修改由于某些原因无法在本地进行测试验证,必须明确说明原因和残余风险。

Unified AI API Gateway — Access 200+ models through one endpoint.