20. 项目约束(AGENTS.md)


AGENTS.md 是 Codex 世界里最重要的配置文件,作用类似于给新入职的工程师写一份"项目须知"。这份文件通常放在仓库根目录,也就是和 package.jsonREADME.md 同一层。这样 Codex 进入项目后就能优先读到它。

一个实用的 AGENTS.md 应该包含以下内容:

# AGENTS.md

## 项目简介
这是一个基于 Next.js 14 + Prisma + PostgreSQL 的 SaaS 平台后端服务。

## 技术栈
- 运行时:Node.js 20
- 框架:Next.js 14(App Router)
- ORM:Prisma 5
- 数据库:PostgreSQL 15
- 测试:Vitest + MSW
- 包管理器:pnpm

## 常用命令
- 安装依赖:pnpm install
- 运行开发服务器:pnpm dev
- 运行测试:pnpm test
- 数据库迁移:pnpm prisma migrate dev
- 代码检查:pnpm lint
- 类型检查:pnpm typecheck

## 编码规范
- 使用 TypeScript,所有函数必须有类型注解
- 组件使用函数式声明
- 命名规范:文件 kebab-case,组件 PascalCase,变量 camelCase
- 错误处理必须具体,不允许空 catch 块
- commit 信息遵循 Conventional Commits

## 目录结构
- src/app/ — Next.js 路由和页面
- src/components/ — 可复用 UI 组件
- src/server/ — 服务端逻辑(API 路由、服务层)
- src/lib/ — 工具函数和配置
- prisma/ — 数据库 schema 和迁移

## 注意事项
- 不要直接修改 prisma/migrations/ 下的已有文件
- 环境变量通过 .env 配置,不要硬编码
- 所有新 API 必须编写对应测试

AGENTS.md 不需要一开始就写得很完整。更实用的做法是先写一版基础说明,后面在使用 Codex 的过程中不断补充。如果你发现它总是改错目录、忘记补测试,或者喜欢去动不该动的文件,就把这些规则补进去。文件越贴近项目实际,Codex 的输出通常就越稳定。

评论

0
还没有评论,来写第一条吧