AGENTS.md：教会 Codex 你的代码库

代码示例

1# 全局代理指令
2
3## 工具链
4- Python 3.11+
5- 使用 ruff 进行代码检查，使用 black 进行格式化
6- 所有测试均使用 pytest
7
8## 风格
9- 为每个公共函数编写文档字符串
10- 尽可能将函数保持在 30 行以内
11- 优先选择显式而非隐式

代码示例

1# 项目指令
2
3## 设置
4pip install -r requirements.txt
5
6## 测试
7pytest tests/ -v
8# 单个文件：pytest tests/test_api.py -v
9
10## 应该这样做
11- 所有日志均使用 app/logger.py 中的 logger
12- 状态值使用 app/enums.py 中的枚举
13- 业务逻辑使用 app/services/ 中的服务层
14
15## 不应该这样做
16- 不要使用 print 语句进行日志记录
17- 不要在路由处理器中直接获取数据
18- 未经批准不得添加新依赖
19
20## 项目结构
21- 路由：app/routes/
22- 服务：app/services/
23- 模型：app/models.py
24
25## 优秀示例
26- 参照 app/routes/users.py 中的模式
27- 避免使用 app/routes/admin.py 中的旧式写法
28
29## 安全与权限
30无需询问即可执行：读取文件、运行单文件测试、代码检查、类型检查
31需要先询问：包安装、git push、删除文件、完整项目构建
32
33## 审查指南
34- 标记任何缺少认证中间件的路由
35- 标记应使用常量或枚举但硬编码的值
36- 标记任何在过滤列上未建立索引的数据库查询