AGENTS.md

AGENTS.md 是 Zenith Admin 的"项目说明书"，位于仓库根目录。主流 AI 编程工具（GitHub Copilot、Claude Code、Cursor 等）在进入项目时会自动读取此文件，从而了解项目的技术栈、架构约定与常见陷阱。

---

它的作用

AI 工具在生成代码、回答问题或执行重构时，会参照 AGENTS.md 中的约定来确保输出与项目现有风格一致。它相当于一份"机器可读的编码规范"——无需反复提醒 AI，规则就自动生效。

没有这份文件时，AI 可能会：

• 使用不符合项目约定的响应格式或组件库
• 忽略统一的布局规范和命名习惯
• 遗漏数据库迁移、枚举同步等容易出错的步骤

涵盖哪些方面

AGENTS.md 按模块组织，覆盖了以下几类信息（具体内容请直接阅读原文）：

• 技术栈与架构：后端、前端、共享层各自的框架选型和职责划分
• 常用命令：开发、构建、数据库迁移等日常操作
• 编码约定：响应格式、组件使用、页面布局等统一规范
• 常见陷阱：开发中容易踩坑的注意事项
• Demo 演示模式：MSW Mock 的维护要求

具体条目可能随项目演进而增减，始终以仓库根目录的 AGENTS.md 原文为准。

如何维护

当项目的架构约定发生变更时，应同步更新 AGENTS.md，确保 AI 工具获取的信息始终是最新的。

常见需要更新的场景：

• 新增或修改了全局中间件、统一响应格式
• 约定了新的组件规范或布局规则
• 变更了数据库工作流或命名习惯
• 引入了新的第三方库或替换了现有依赖