docs: AGENTS.md 增加收尾提交规则,发版流程改为工具驱动一条线
现象:发版流程里「手动提交 + 手动打 tag」与 bump-my-version 的 commit = true / tag = true 冲突,真用工具会撞同名 tag;另外没有写清「何时提交、何时必须先提交」,导致为 1 行 uv.lock 单开了提交(4784ac0)。 根因:发版步骤是按手动流程写的,后来才配了自动提交 + 打 tag 的工具,两边没有对齐;提交时机 只散落在发版一节里。 边界: - 新增「收尾(Commit)」:任务完成后自动提交,一个任务一个 commit;附带产物(如 uv.lock) 跟着产生它的任务走;重大变更(改依赖 / 表结构 / 规则文档 / 发版)开始前工作区必须干净; 发版本只在用户确认后触发 - 「发版本流程」改为:整理 CHANGELOG 并普通提交 → uv lock 自检 → 工作区干净后 uv tool run bump-my-version bump patch 一次完成改三处版本 + 提交 + 打 tag;不再手动 commit / tag - docs/agent_workflow.md 记入三条:发版配置要 dry-run、发版只留一条线、附带产物不单开提交 - 不改代码、不改版本号、不打 tag 运行了什么:git status 自查(只提交这 2 个文档文件);提交时 pre-commit 跑 ruff / web typecheck / commitizen 没跑什么:没跑 bump-my-version 真实发版;没跑测试、没构建(本次无代码改动)
This commit is contained in:
@@ -41,6 +41,14 @@
|
||||
- Seen:1×
|
||||
- 状态:观察中(文档里的 python 代码块以钩子结果为准,别手改对抗)
|
||||
|
||||
### 发版配置写完要真跑一次 dry-run
|
||||
|
||||
- 为什么:没验证过的发版配置会在发版当天才暴露问题,那时最没有余量排查。
|
||||
- 证据:
|
||||
- `ecadae5` 之前的 `pyproject.toml`:`bump-my-version` 默认 `regex = false`,且仓库文件是 CRLF,原 `search` 真跑报 `Did not find '(?m)^version = "0.0.8"$' in file: 'pyproject.toml'`,这条发版命令从未成功过。
|
||||
- Seen:1×
|
||||
- 状态:观察中(改发版配置后跑 `bump-my-version bump patch --dry-run --allow-dirty -vv`,确认三处都会被改)
|
||||
|
||||
## 已升级 → AGENTS.md
|
||||
|
||||
### 修改已存在文件:一次清单、一次同意
|
||||
@@ -92,6 +100,22 @@
|
||||
- Seen:2×
|
||||
- 状态:已升级 → AGENTS.md「文档规范」(`docs/todo.md` 已删除;其中 2 条仍未修的代码问题已迁入 `docs/progress/todo.md`)
|
||||
|
||||
### 发版流程只留一条线,别让手动步骤和工具自动步骤并存
|
||||
|
||||
- 为什么:工具已经自动提交 + 打 tag,文档还写「提交完成后手动打 tag」,照做就会撞同名 tag 失败。
|
||||
- 证据:
|
||||
- `ecadae5`:`pyproject.toml` 里 `commit = true` / `tag = true`,而当时 `AGENTS.md` 发版流程仍有「提交完成后,给当前提交打 tag」一条。
|
||||
- Seen:1×
|
||||
- 状态:已升级 → AGENTS.md「发版本流程」(改为 bump-my-version 一次完成改版本 + 提交 + 打 tag)
|
||||
|
||||
### 附带产物跟着任务走,不单开提交
|
||||
|
||||
- 为什么:为 1 行 `uv.lock` 单开提交会让历史里充满噪音,也让「一个任务一个 commit」失去意义。
|
||||
- 证据:
|
||||
- `4784ac0`:`chore: uv.lock 的 study-tool 版本同步到 0.0.8`,仅 1 行改动,是 v0.0.8 发版的遗留;用户指出「完成一个任务才需要提交」。
|
||||
- Seen:1×
|
||||
- 状态:已升级 → AGENTS.md「收尾(Commit)」
|
||||
|
||||
## 已否决(不要再提议)
|
||||
|
||||
| 规则 | 原因 |
|
||||
|
||||
Reference in New Issue
Block a user