模板

最小 AGENTS.md 模板:可直接用于 Codex 项目

一份可复制的 AGENTS.md 起步模板,覆盖项目结构、命令、修改约束、安全规则和完成标准。

使用方式

把下面内容保存到仓库根目录的 AGENTS.md,然后根据真实项目删除、替换示例。不要保留不存在的命令。

# 项目 Agent 指引

## 项目结构
- `src/`:应用代码
- `tests/`:自动化测试
- `docs/`:项目文档

## 开发命令
- 安装:`npm install`
- 本地开发:`npm run dev`
- 类型检查:`npm run check`
- 测试:`npm test`
- 构建:`npm run build`

## 修改规则
- 修改前先阅读相关模块和现有测试。
- 保留用户已有的未提交修改。
- 不修改生成文件,除非任务明确要求。
- 优先沿用现有组件和依赖。

## 安全
- 不读取、输出或提交密钥和个人数据。
- 生产部署、付款和删除数据需要明确授权。

## 完成标准
- 相关测试和检查通过。
- 最终说明列出改动、验证和剩余风险。

调整建议

把真正影响执行的特殊规则放进去,例如数据库迁移顺序、部署平台、代码生成命令或子目录边界。规则发生变化时同步更新,过期说明会比没有说明更危险。

社区讨论

补充你的经验或问题

评论由 GitHub Discussions 承载;参与讨论需要登录 GitHub。