Web 实践

项目配置

AGENTS.md / PROJECT_STATE 配置详解

配置文件体系

项目根目录/
├── AGENTS.md          # 唯一协作规范入口
├── CLAUDE.md          # Claude Code 兼容跳转壳(0.1.4+)
├── PROJECT_STATE.md   # 任务状态(执行时自动创建)
└── docs/
    ├── WORKFLOW_TEMPLATES.md      # 工作流 SOP
    ├── PROJECT_STATE_TEMPLATE.md  # PROJECT_STATE 模板
    ├── REVIEW_TEMPLATES.md        # 评审标准
    └── ARCHITECTURE.md            # 项目架构

PROJECT_STATE.md

用于跨会话接力,0.1.4 起推荐固定 8 区块:

  1. 目标
  2. 下一步 Top 3
  3. 阻塞项
  4. 关键决策索引(最近 3 条)
  5. 关键决策日志(全量追加)
  6. 验收证据(Evidence)
  7. 未验证清单(Gaps)
  8. 提交计划

创建时机

首次执行 feat/fix/refactor/chore 任务时自动创建。

更新时机

  • 列出/更新 todo 时
  • 开始执行某个 todo item 时
  • 完成某个 todo item 时
  • 遇到问题或决策点时
  • 阶段切换时

上下文管理

主动检查

对话较长时(>10轮或大量代码变更后),Agent 应主动提醒用户检查上下文:

  • Claude Code:输入 /context 查看
  • Codex:输入 /status 查看

切换准备

当用户告知上下文不足或 Agent 感知对话过长时:

  1. 暂停当前任务
  2. 更新 PROJECT_STATE.md
  3. 仅在用户明确要求时执行 commit
  4. 输出切换提示

Commit Policy(0.1.4)

  • 仅当用户明确要求时执行 git commit
  • 禁止默认执行 git push
  • Co-Authored-By 使用动态模型名:Co-Authored-By: <llm-model>
  • 默认不提交 PROJECT_STATE.md,除非跨环境同步或用户明确要求

兼容说明

  • 0.1.3 及更早版本中,常见做法是 AGENTS.md / CLAUDE.md 双份同内容。
  • 0.1.4 起建议单一入口(AGENTS)+ 跳转壳(CLAUDE)。

目录