docs: 发版流程拆成通用与项目两层
现象:AGENTS.md「发版本流程」里写死了本项目的文件名和命令(metadata.yaml、uv tool run bump-my-version、uv.lock),换项目没法直接复用;手写那一行还出现了 `runm` 和 `etadata.yaml` 两处笔误。 根因:通用规则和项目实现细节混在同一节,规则文件承担了本该属于架构文档的内容。 边界: - AGENTS.md「发版本流程」改成通用表述:确认后触发、CHANGELOG 整理、锁文件自检、发版工具一次 完成改版本 + 提交 + 打 tag、tag 查重、发版不构建;不再出现具体文件名和命令 - docs/architecture.md 新增「发版」一节,放本项目的三处版本文件、bump-my-version 命令、 CRLF + regex 的配置坑、改配置后先 dry-run - docs/agent_workflow.md「项目契约和 Agent 行为规则分开」补上这次的证据,Seen 升到 2× - 不改代码、不改版本号、不打 tag 运行了什么:git status 自查(只提交这 3 个文档文件);提交时 pre-commit 跑 ruff / web typecheck / commitizen 没跑什么:没跑 bump-my-version 真实发版;没跑测试、没构建(本次无代码改动)
This commit is contained in:
@@ -88,7 +88,8 @@
|
||||
- 为什么:行为规则和项目契约混在一个文件里,改契约时没人会想到 review 规则文件,两边都不好维护。
|
||||
- 证据:
|
||||
- `v0.0.8 (aa48145)`:`AGENTS.md` 93 行,其中「日志规范」+「代码结构 / 平台插件」约 4KB 是项目契约,而 `docs/architecture.md` 已在维护同一套分层与插件契约。
|
||||
- Seen:1×
|
||||
- `d8808e6`:`AGENTS.md`「发版本流程」里写死了本项目的文件名和命令(`metadata.yaml`、`uv tool run bump-my-version …`),用户指出这些该放进 `docs/architecture.md`,`AGENTS.md` 只留通用流程;手写命令还出现过 `runm` / `etadata.yaml` 这类笔误。
|
||||
- Seen:2×
|
||||
- 状态:已升级 → AGENTS.md「项目契约」(两节已并入 `docs/architecture.md`,AGENTS.md 降到 79 行)
|
||||
|
||||
### 一个文件只留一份权威账本
|
||||
|
||||
Reference in New Issue
Block a user