Files
Genarrative/docs/project-memory/README.md
T
kdletters 9476ff7648
Project CI / Frontend tests (push) Successful in 4m5s
Project CI / Repository checks (push) Successful in 4m23s
Project CI / Backend tests (push) Successful in 5m1s
Project CI / Native shell tests (push) Failing after 10m54s
迁移仓库工具资源到 Codex 并固化执行边界
将 .hermes 工具资源迁移至 .codex

同步代码、文档与 RAG 路径引用

补充任务范围、验收与时间盒执行规则
2026-08-27 13:55:25 +08:00

1.8 KiB

项目记忆目录

本目录只保存可以通过 Git 共享、并且对当前开发仍有效的项目知识。.codex/ 只放 Codex 工具资源,不作为项目知识库。

当前结构

docs/project-memory/
├─ README.md
├─ shared-memory/
│  ├─ project-overview.md
│  ├─ team-conventions.md
│  ├─ development-workflow.md
│  ├─ document-map.md
│  ├─ decision-log.md
│  ├─ pitfalls.md
│  └─ handoff-template.md
├─ plans/   # 仅限正在执行的短期计划
└─ todos/   # 仅限仍开放且有退出条件的事项

使用原则

  • 开发前先读 AGENTS.md;复杂任务再读 Agent 执行准则、共享记忆和任务对应的当前专题文档。
  • 稳定架构、接口、流程和排障边界写入 shared-memory/;同一事实只保留一个当前口径,细节放在权威专题文档。
  • plans/ 只保存正在执行、具有明确剩余项和验收门禁的计划;完成或作废后立即删除,稳定结论融合进当前专题或共享记忆。
  • todos/ 只保存真实开放、有人接手即可执行的事项;每项应写明状态、下一决策点和关闭条件。已退役对象不保留未来 TODO。
  • 分支、提交、测试轮次和阶段流水账不进入长期记忆;需要追溯时使用 Git 历史。
  • 若本目录与代码或最新 docs/ 冲突,以代码和最新专题为准,并在同次变更中修正记忆。
  • 禁止写入个人配置、API Key、Token、Cookie、会话记录、认证文件、本地私密路径、构建产物、日志、缓存和数据库 dump。

RAG 索引

本目录是本地 RAG 的高权重索引源,但检索结果只作为候选上下文。索引脚本位于 scripts/rag/;运行时依赖和 .rag/ 数据默认不安装、不提交,启用前需先征得用户确认。