Files
zhuangang/topics/ai/ai-coding/examples/ai-workflow/AGENTS.md
T

946 B
Raw Blame History

AGENTS.md(示例:给 AI 编程工具读的项目说明)

Cursor、Codex 等工具会读取仓库根目录的 AGENTS.md;Claude Code 读取 CLAUDE.md(可以在其中引用本文件)。支持情况以各工具官方文档为准。

项目

  • 后端:Python 3.12 + FastAPI,app/;测试 tests/;依赖用 uv 管理。
  • 前端:Vue 3 + TypeScript,web/。

常用命令

  • 安装:uv sync
  • 测试:uv run pytest -q
  • 检查:uv run ruff check . && uv run mypy app

约定

  • 新接口必须有 pydantic 请求 / 响应模型和至少一个测试。
  • 不要修改 migrations/ 中已存在的文件,新增迁移。
  • 不要在代码、测试、日志中写入真实密钥、内网地址、客户数据。
  • 每次改动后运行测试;测试不通过不要说“完成了”。

完成标准

  • uv run pytest -q 全部通过;新增代码有测试;说明改了哪些文件、怎么验证的。