docs: 创建任务 #3 归档
@@ -0,0 +1,64 @@
|
||||
# 3 将 DevHarness 工具目录重命名为 dev_scripts
|
||||
|
||||
- 类型:重构
|
||||
- 所属 Epic:无
|
||||
- 所属 MVP / 版本:无
|
||||
- 状态:待验收
|
||||
- 日期:2026-08-08
|
||||
- Gitea 工单:[opc/dev_harness#3](http://ilaer.eicp.net:8418/opc/dev_harness/issues/3)
|
||||
- Wiki 页面:Task-3-Dev-Scripts-Rename
|
||||
- Wiki revision:见本地镜像头
|
||||
|
||||
## 背景与目标
|
||||
|
||||
DevHarness 自身工具原来放在根目录 `scripts/`,容易和后续业务项目的脚本混淆。本任务把 Harness 检查、Wiki 同步和任务归档工具统一迁移到 `dev_scripts/`,不保留旧路径兼容入口。
|
||||
|
||||
## 最终方案
|
||||
|
||||
- `scripts/check_harness.py` → `dev_scripts/check_harness.py`。
|
||||
- `scripts/wiki_docs.py` → `dev_scripts/wiki_docs.py`。
|
||||
- `scripts/sync_wiki_docs.py` → `dev_scripts/sync_wiki_docs.py`。
|
||||
- `scripts/new_task_archive.py` → `dev_scripts/new_task_archive.py`。
|
||||
- 更新测试导入路径、必需文件检查、AGENTS、README 和稳定 Wiki 页面。
|
||||
- Wiki 先修改并读取确认,再导出本地镜像。
|
||||
- 历史任务 #1、#2 保留旧路径,避免改写历史事实。
|
||||
- 旧 `scripts/` 目录不保留包装器,未来业务脚本必须与 `dev_scripts/` 分开。
|
||||
|
||||
## 修改文件
|
||||
|
||||
- `scripts/**` → `dev_scripts/**`:整体目录重命名。
|
||||
- `dev_scripts/check_harness.py`:必需工具路径改为新目录。
|
||||
- `tests/test_wiki_docs.py`、`tests/test_harness_docs.py`:导入新目录。
|
||||
- `AGENTS.md`:更新同步、归档命令和目录边界。
|
||||
- `README.md`:更新快速开始和目录说明。
|
||||
- `docs/README.md`、项目档案、工作流、代码地图、开发验证、常见修改和新项目初始化:线上 Wiki 的更新镜像。
|
||||
|
||||
## 验收结果
|
||||
|
||||
| 验收标准 | 结果 |
|
||||
|---|---|
|
||||
| 四个工具位于 dev_scripts,旧目录不存在 | 通过 |
|
||||
| 新命令可运行且不保留旧兼容入口 | 通过 |
|
||||
| 测试导入和必需文件检查使用新路径 | 通过 |
|
||||
| 稳定 Wiki 与本地镜像使用新路径 | 通过 |
|
||||
| 非历史内容没有旧路径引用 | 通过 |
|
||||
| 测试、严格检查、同步和编译通过 | 通过 |
|
||||
|
||||
## 测试
|
||||
|
||||
- 执行命令:`python -m unittest discover -s tests -v`
|
||||
- 结果:16/16 通过。
|
||||
- 执行命令:`python dev_scripts/check_harness.py --strict`
|
||||
- 结果:通过。
|
||||
- 执行命令:`python dev_scripts/sync_wiki_docs.py --check`
|
||||
- 结果:12/12 映射一致。
|
||||
- 执行命令:`python -m compileall -q dev_scripts tests`
|
||||
- 结果:通过。
|
||||
- 执行命令:旧目录和非历史旧路径搜索。
|
||||
- 结果:旧目录不存在;非历史旧路径无残留。
|
||||
- **未验证部分**:仓库外部未纳入版本管理的自动化如果仍使用旧命令,需要使用方自行更新。
|
||||
|
||||
## 相关提交
|
||||
|
||||
- `1c99867` refactor: 将 Harness 工具移至 dev_scripts (#3)
|
||||
- `51278fa` docs: 修正 dev_scripts 编译检查命令 (#3)
|
||||
Reference in New Issue
Block a user