用途:把仓库的项目记录维护成一件持续、低摩擦的事,覆盖三类记录。DEVLOG.md 记录发生了什么、何时、为何;docs/adr/ 下的 ADR 回答项目为何是现在这个形态;CHANGELOG.md 记录每次发布改了什么。
主要能力:commit 主题为 changelog 提供素材并遵循统一规则;脚本 scripts/project-records.ps1 强制执行机械规则并渲染 changelog。提供“Log this”“Write an ADR for this”“Cut the release”“Adopt project records here”等入口。
使用方式:写记录前先阅读工作区自身规则(DEVLOG 头部 ## Conventions、docs/adr/README.md、records.config.json、AGENTS.md 的 records 段),工作区规则优先。DEVLOG 条目须确认触发条件、选一个类别和三到五个标签,写 Summary、Detail、Related,插入在条目顶部,独立条目先展示草稿再以 docs(records): <title> 按路径提交。ADR 先读触发规则,取下一个编号,从模板复制到 docs/adr/NNNN-kebab-title.md,填六项头部与各节,运行就绪审查,在同一变更中加入索引行,并写伴随 DEVLOG 条目;已接受的 ADR 不得改实质内容,只能由新 ADR 取代。提交主题采用 type(scope): subject,类型取自 records.config.json。发布由操作者执行 push 和 tag,代理执行 changelog-preview、changelog-cut -Tag <tag> 与 check。可先做只读预览:check、changelog-preview、check-msg <file>、check-range -Base <base> -Head HEAD、self-test。
限制与安全:任何记录不得写入凭据、密钥、令牌、密码或个人数据;不得提交用户未见过的独立记录;记录工作不执行 push;仅按路径提交,且需确认暂存区只有自己的路径;不得改写已发布历史。文件位置、提交范围、用词和审批流程若工作区另有规定,以其为准。未提供的内容包括具体安装命令、价格与平台支持等。