Skip to content

Latest commit

 

History

History
80 lines (57 loc) · 4.6 KB

File metadata and controls

80 lines (57 loc) · 4.6 KB

AGENTS.md

本文件是仓库级总控规则。进入子目录工作时,必须同时读取对应子项目的 AGENTS.md

1. 权威来源

  1. docs/ 是学习内容与技术决策的权威来源。
  2. 实践计划与进度 是实战进度状态的唯一权威来源:里程碑状态、卡片顺序、状态、前置与完成记录都在这里。
  3. 编码前读该文件的里程碑状态表与当前卡所属段落(历史里程碑按需查阅),只实现前置已完成且状态为「待开始」的第一张卡片。
  4. 一张卡片只交付一个可感知行为;禁止顺手实现后续卡片。
  5. 进度状态禁止在其他地方重复声明——卡片文件不写状态行,各工程 README.md / AGENTS.md 只指向上述文件。

当前主线:BootMall 的 M2 交易核心(本文件也不复述具体卡片号,按第 3 条规则取)。

2. 仓库结构

admin-client/       B 端管理后台
user-client/        C 端商城
boot-server/        Spring Boot 后端聚合工程
docs/               学习路线、产品蓝图和实践卡片

子项目规则:

3. 单卡闭环

  1. 读卡定界:确认目标、范围、验收和“不做”。
  2. 规范前置:首次引入技术能力前,先补对应子项目规则。
  3. 建立契约:先确定输入输出、错误分支和最小测试场景。
  4. 最小实现:只改达成验收所必需的模块。
  5. 验证复盘:运行自动化测试和卡片要求的真实验证。
  6. 记账收口:验证通过后只改两处——实践计划与进度 里该卡片的状态,以及卡片自己的「完成记录」段。

4. 全局红线

  • 不提交密钥、日志、target/node_modules/dist/、IDE 配置和本地 .env
  • 不修改用户级环境配置,例如 ~/.m2/settings.xml、全局 npm/pnpm 配置。
  • 不自动暂存或提交 boot-server/data/bootapp.mv.db;只有用户明确要求记录数据库快照时才处理。
  • 不使用 git reset --hardgit checkout --、交互式 rebase、强制推送。
  • 提交和推送必须由用户明确要求。

5. 静态值治理

原则:可部署配置从配置源读取;跨模块机器契约(错误码、权限码、存储键等)按职责具名集中;局部声明(路由、endpoint、表单校验、展示文案、单测数据等)就近保留字面量,字符串重复本身不构成抽常量理由。改动相关值后用 rg 扫描旧字面量并说明保留理由。

细则只在两处定义:后端见 boot-server/AGENTS.md 第 4 节,前端见 前端开发规范 第 10 节。

6. Git 工作流

  1. 动手前执行 git status --short
  2. 只暂存本任务相关文件。
  3. 提交前执行 git diff --check 和对应测试。
  4. 提交信息使用中文 Conventional Commits,例如 feat: 新增统一异常处理docs: 更新前端规范
  5. 推送前确认当前分支和待推送提交。

7. 工作方式

  • 先读代码、实践卡片和相邻文档,再修改。
  • 优先复用现有模式,避免一次性抽象。
  • 发现无关问题只记录风险,不扩大本次范围。
  • 版本与 API 细节以 docs/ 与实测为准,不凭记忆写(如 MP 包结构、Boot 4 的 -parameters)。
  • 汇报必须包含改动位置、验证结果和未完成风险。

主模型与 Subagent 的职责划分——主模型只做分析与审核,实施全部交给 Subagent,注意本条规则暂不用于 codex:

主模型(主会话) Subagent
问题分析、方案设计、任务拆解与定界 读代码探索(Explore 类 agent)
审核实施结果(diff review、验收证据核验) 写代码、改文件(general-purpose / claude agent)
决定下一步、记账收口判断 跑命令、构建、测试、CDP 浏览器验收

并行原则:实施类 Subagent 仅在任务范围明确且互不依赖时并行;探索与规则读取默认串行、按需最小化,不做启动时全量扫描。有依赖的任务必须串行(实现 → 测试 → 验收)。

主会话已读取的规则约束,须在任务说明中摘要转述给 Subagent;Subagent 只读与任务直接相关的规范节选,不重复通读规则链。