mirror of
https://github.com/zhw2590582/ArtPlayer.git
synced 2026-10-12 23:36:15 -08:00
docs(refactor): [DOC-05] establish refactor docs and per-task commits
This commit is contained in:
1 parent
40fcda6a37
commit
570600d2f6
18 files changed
+5524
No files matched your search
@@ -0,0 +1,33 @@
|
||||
# DOC-05 文档初始化与每任务独立提交
|
||||
|
||||
- 日期:2026-09-10。
|
||||
- 分支:`codex/compatible-modernization`。
|
||||
- 基线:`40fcda6a37d0049d42e49c1e64e70d4fd9ba5f7f`。
|
||||
- 提交主题:`docs(refactor): [DOC-05] establish refactor docs and per-task commits`。
|
||||
- 关联决策:ADR-007、ADR-013、ADR-014。
|
||||
|
||||
## 问题与变化
|
||||
|
||||
此前已创建分支和规划文件,但没有规定每任务完成后必须提交。用户明确补充:每完成一个任务就创建一个 commit。
|
||||
|
||||
现在根 AGENTS.md、README、AI 流程、质量验收和变更模板都要求:任务通过验收后,包含任务 ID 的独立提交同时保存实现、测试、文档和状态;核实提交成功后才能开始下一任务。失败不能当作已完成交付。推送和发布未被这项授权涵盖。
|
||||
|
||||
DOC-01 至 DOC-04 在新规则前已经完成,文件尚未进入 Git。本次 DOC-05 将这些已有文档作为初始基线一并入库;不伪造更早的独立提交。之后新增完成的任务各自提交。
|
||||
|
||||
## 范围与兼容
|
||||
|
||||
仅 AGENTS.md 与 refactor/。没有修改生产代码、公开声明、依赖或构建产物。新增任务规则不改变浏览器用户的行为。
|
||||
|
||||
## 验证与追溯
|
||||
|
||||
- `node refactor/scripts/plan.mjs --write`:生成 191 项计划。
|
||||
- `node refactor/scripts/plan.mjs --check`:检查任务、依赖、22 包、链接与生成同步。
|
||||
- `node --check refactor/scripts/plan.mjs`:语法检查。
|
||||
- `git diff --cached --check`:提交内容格式检查。
|
||||
- 提交后使用 `git log -1 --format='%h %s'` 与 `git status --short` 核对实际提交和工作区。
|
||||
|
||||
SHA 通过上述提交主题在 Git 历史中追溯;在同一提交中写自身 SHA 会导致循环修改,因此不在这里预填。生产测试不适用于本次纯文档初始化,前期诊断仍单独列在 progress.md。
|
||||
|
||||
## 回退与下一步
|
||||
|
||||
必要时独立回退本次文档提交,不影响生产实现。下一项为 BASE-01,必须在 DOC-05 本地提交成功后开始。
|
||||
@@ -0,0 +1,45 @@
|
||||
# <任务 ID> <变更主题>
|
||||
|
||||
## 范围
|
||||
|
||||
- 日期、分支、基线 SHA、关联任务:
|
||||
- 修改模块、受影响包和消费者:
|
||||
- 关联兼容契约和 ADR:
|
||||
- 完成提交主题(包含任务 ID;SHA 通过 Git 日志查找):
|
||||
|
||||
## 旧行为与证据
|
||||
|
||||
源码、声明、发布包和文档分别记录;提供最小用户调用或复现步骤。标明已复现与待验证。
|
||||
|
||||
## 改动与理由
|
||||
|
||||
记录最终方案、内部职责变化、资源所有者、错误/取消/事件语义。必要时解释放弃的备选方案。
|
||||
|
||||
## 兼容评估
|
||||
|
||||
| 范围 | 原行为 | 新行为 | 兼容结论/例外 |
|
||||
| --- | --- | --- | --- |
|
||||
| JS API | 待填 | 待填 | 待填 |
|
||||
| TypeScript | 待填 | 待填 | 待填 |
|
||||
| 事件/Promise/生命周期 | 待填 | 待填 | 待填 |
|
||||
| DOM/CSS/插件集成 | 待填 | 待填 | 待填 |
|
||||
| 发布入口和资源 | 待填 | 待填 | 待填 |
|
||||
|
||||
## 验证
|
||||
|
||||
| 命令/用例 | 环境与产物 SHA | 结果 | 持久报告/证据 |
|
||||
| --- | --- | --- | --- |
|
||||
| 待填 | 待填 | 未运行 | 待填 |
|
||||
|
||||
记录失败、跳过、真实浏览器/设备未验证项,不把没有运行的检查写成通过。
|
||||
|
||||
## 发布与回退
|
||||
|
||||
版本影响、兼容别名/适配、依赖范围、回退提交/旧版本、是否需要重新生成产物。
|
||||
|
||||
## 结论与后续
|
||||
|
||||
是否满足本任务验收、阻塞、后续任务 ID、文档更新。按实际证据更新 tasks.json,模板自身不能作为完成证据。
|
||||
验收后将本任务的实现、测试、文档和状态单独提交,核实实际 SHA;提交失败时不能报告交付完成。
|
||||
|
||||
同时对照 quality-contract.md,记录职责拆分、已处理的不合理设计、包内实现地图、风险对应测试和后续 AI 修改入口。无法适用的项目说明原因,不机械打勾。
|
||||
Reference in new issue
Block a user