Prompts-MCP 686 skills · ai / design / design-pattern / framework / fundamentals / habit / lang / tech-selection /mcp/sse
habit habit/prd-sync/update-on-code-change.md medium

prd-update-on-code

CLAUDE.md Step 8 — 代码改 → 必更对应 <SUB_ID>-*.md Change Log。Use when 改子模块 PRD / 评审涉及 `update-on-code-change` 的 PR。

prdchange logstep 8代码改必更对应
paths
  • project-index/modules/**
  • **

PRD Sync · 代码改 → 必更 PRD

规则(CLAUDE.md Step 8 硬性节点)

每次代码改动后必须同步更新对应 PRD 子模块的 Change Log

操作步骤

1. 反查改动文件  mapping/module_path_map.md  找到 module + MODULE_ID
2. 编辑 modules/<module>/<MODULE_ID>-*.md文件夹格式 modules/<module>.md 对应小节
   -  status spec-ready  in-progress
   - 勾产物清单(⬜  ✅)
   -  Change Log 
3. 如果 artifacts 路径有增删  同步 manifest.yaml submodule.artifacts
4. 如果新增/删除子模块  同步 <module>/README.md 子模块清单
5. PRD 改动 + 代码改动  同一个 commit

Change Log 格式

每个子模块 .md 末尾固定段:

## Change Log

| 日期 | 改动 | commit |
|------|------|--------|
| 2026-05-24 | 实现卡片组件初版 | abc1234 |
| 2026-05-25 | 加 hover 动画 | def5678 |

每次代码改动追加一行。commit 用 short hash。

三层保险(与 CLAUDE.md Step 8 配套)

实现 强度
CLAUDE.md Step 8 流程契约 靠遵守
PostToolUse hook(项目自有 post-tool 脚本) stderr 告警
CI workflow(项目自有的 prd-sync 检查) PR 时阻断 merge

PostToolUse hook 行为

# 检测:源码改了但 PRD 未改 → stderr 警告(不阻断)
$ vim backend/routers/textbooks.py
⚠️  PRD-sync 提醒:
   你改了 backend/routers/textbooks.py (归属模块: textbook_data)
   但本会话未更新对应 PRD(project-index/modules/textbook_data/  .md)
   CLAUDE.md Step 8 要求同步更新对应子模块 .md  Change Log

详见项目自有的 PostToolUse hook 脚本。

CI workflow 行为

# .github/workflows/prd-sync-check.yml
# 改了 backend/ / frontend/ / py/ 但未改 project-index/modules/ → 阻断

PR 标签 prd-sync-deferred 可跳过(仅紧急 hotfix)。

反例

# ❌ 只 commit 代码不动 PRD
git add backend/routers/textbooks.py
git commit -m "feat(textbook-data):新增 textbooks 路由"
# CI 阻断:PRD 未同步

# ✅
git add backend/routers/textbooks.py
git add project-index/modules/textbook_data.md   # 更新 Change Log + 勾产物
git commit -m "feat(textbook-data):新增 textbooks 路由"

自检

  • [ ] PRD Change Log 添加了一行?
  • [ ] artifacts 清单状态更新(⬜ → ✅)?
  • [ ] PRD 改动与代码改动同一 commit?
  • [ ] CI prd-sync-check 通过?

相关