请为当前仓库根目录编写 AGENTS.md,用于指导整个项目的开发与协作。
要求:
-
先阅读当前仓库的目录结构、已有文档和关键配置,确保
AGENTS.md与项目实际情况一致。 -
AGENTS.md应提供充分的项目级上下文,但保持 high-level;实现细节、模块设计、规范等应链接到对应文档,而不是直接展开。 -
AGENTS.md必须少于 400 行,内容精炼、明确、可执行。 -
明确要求所有 Agents 维护根目录下的
PROCESS.md:
-
用于记录项目进展、重要决策、已完成工作和后续事项。
-
按时间倒序排列,最新内容在最前。
-
保持精炼,少于 500 行。
-
若超过 500 行,应主动压缩、合并或删除已过时内容,恢复到 500 行以内。
- 每个 fresh session 开始时,Agent 必须先阅读:
-
PROCESS.md -
最近 7 个 Git commits 的详细信息(包括 commit message 和 diff)
以快速恢复项目上下文。
- 每次任务完成后必须:
-
更新
PROCESS.md; -
创建一个原子化 commit,只包含本次任务相关改动;
-
检查不应纳入版本控制的文件,并按需更新
.gitignore; -
确保最终 Git working tree clean。
-
AGENTS.md应明确上述工作流是默认强制流程,并避免重复记录可以从代码、Git 历史或其他文档直接获得的信息。 -
如果现有项目结构或文档不足以确定某些规则,可以先提出建议并与我讨论,再写入
AGENTS.md。
先分析仓库现状,再给出你建议的 AGENTS.md 内容。