@elvis1513/auto-coding-skill 0.3.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,24 @@
1
+ # Closure Log(默认轻量闭环记录:每个任务至少一条)
2
+
3
+ 规则:
4
+ 1) 每个任务完成后,至少追加一条闭环记录
5
+ 2) 默认记录真实提交、Jenkins、目标环境验证结果
6
+ 3) Jenkins 失败后再修复的任务,应补充失败原因和修复提交
7
+ 4) 这里是默认闭环文档;长 summary 只用于高风险或复盘任务
8
+
9
+ ---
10
+
11
+ ## <TASK_ID> — <Title> — YYYY-MM-DD HH:MM
12
+ - Task: <TASK_ID>
13
+ - Commit: <commit sha>
14
+ - Jenkins Build: <build url>
15
+ - Target Env: <env name / health url / page path>
16
+ - Verification: <health / key api / key page / business path>
17
+ - Result: PASS / FAIL / PARTIAL
18
+ - Follow-up: <none or todo>
19
+ - Jenkins Failure: <optional>
20
+ - Fix Commit: <optional>
21
+
22
+ ---
23
+
24
+ 继续在下方追加记录(不要删除历史记录)
@@ -1,5 +1,7 @@
1
1
  # Task Summary — <TASK_ID> — <Title>
2
2
 
3
+ > 仅用于高风险、跨模块、阶段性里程碑、需要完整复盘的任务。
4
+
3
5
  - Task ID:<TASK_ID>
4
6
  - Date:YYYY-MM-DD
5
7
  - Scope(本次范围):
@@ -9,47 +11,22 @@
9
11
 
10
12
  ## 1. 目标与验收结论
11
13
  - 目标:
12
- - 验收结论:PASS / FAIL(FAIL 必须说明原因与后续计划)
14
+ - 验收结论:PASS / FAIL
13
15
 
14
- ## 2. 变更概览(代码/配置/本地运行/Jenkins)
16
+ ## 2. 变更概览
15
17
  - 关键改动点:
16
18
  - 影响模块:
17
- - 兼容性影响(是否破坏兼容、迁移方案):
18
-
19
- ## 3. 接口变更(以 API Markdown 为准)
20
- - 新增:
21
- - 修改:
22
- - 废弃:
23
- - 变更记录位置:`docs/interfaces/api-change-log.md`(对应条目)
19
+ - 兼容性影响:
24
20
 
25
- ## 4. 数据变更(如有)
26
- - 表/字段变更:
27
- - 迁移方式:
28
- - 回滚方式:
21
+ ## 3. 质量证据
22
+ - 本地轻量校验:build / test or quick_test / lint / typecheck / api docs / jenkinsfile / diff-check
23
+ - Jenkins Build:
24
+ - 目标环境验证:
25
+ - 闭环记录:`docs/tasks/closure-log.md`
29
26
 
30
- ## 5. 质量门禁证据(必须可追溯)
31
- - 项目配置:`docs/ENGINEERING.md`(frontmatter)
32
- - 后端测试:`commands.test`
33
- - 前端构建:`commands.build`
34
- - 静态分析:`commands.lint`
35
- - 前端类型检查:`commands.typecheck`
36
- - Review 文档:`docs/reviews/<TASK_ID>-<timestamp>.md`
37
- - API 文档:`docs/interfaces/api.md`
38
- - Jenkins 配置检查:`Jenkinsfile` + `jenkins.*`
39
- - 回归矩阵:`docs/testing/regression-matrix.md`(全量 PASS,0 fail,且每项必须有真实证据)
40
-
41
- ## 6. Bug 清单与回归用例
42
- - 新增/确认的 Bug(写入 `docs/bugs/bug-list.md`):
43
- - 新增自动化回归用例(引用回归矩阵ID):
44
-
45
- ## 7. 本地运行与 Jenkins 部署记录
46
- - 本地 Compose 验证:health / smoke / regression 结果
47
- - Jenkins 部署记录:`docs/deployment/deploy-records/<TASK_ID>-YYYYMMDD.md`
48
- - Docker compose / image / Jenkins Job 变更(若有):
49
-
50
- ## 8. 风险与回滚
27
+ ## 4. 风险与回滚
51
28
  - 风险:
52
- - 回滚点(备份/回滚步骤):
29
+ - 回滚方式:
53
30
 
54
- ## 9. 后续行动(如有)
31
+ ## 5. 后续行动
55
32
  - TODO:
@@ -1,34 +1,41 @@
1
- # Taskbook(任务本:持续续写,权威任务来源)
1
+ # Taskbook(任务本:持续续写,默认权威任务来源)
2
2
 
3
3
  规则:
4
- 1) 所有任务都写在本文件(持续续写,不另起任务文件)
5
- 2) 允许拆子任务:每个子任务也必须走全流程(DD→实现→测试→review→接口文档→本地 Compose 验证→回归→总结→commit→push→Jenkins 验证)
6
- 3) 每个任务必须有明确验收与证据(日志/报告/文件路径)
4
+ 1) 所有任务都写在本文件(持续续写,不另起零散任务文件)
5
+ 2) 普通小改动只要求最小设计记录;跨模块、接口、数据库、部署、Jenkins、关键页面流程变更才补 DD
6
+ 3) 每个任务最终必须有闭环证据:提交、Jenkins、目标环境验证、结果、遗留问题
7
+ 4) 长 summary 不是默认强制产物;只有高风险或需要完整复盘时再补
7
8
 
8
9
  ---
9
10
 
10
11
  ## Task T0001 — <Title>
11
- - 状态:Planned | Designing | Implementing | Testing | Reviewing | Runtime Verifying | Pipeline Verifying | Done
12
+ - 状态:Planned | Designing | Implementing | Local Checking | Pipeline Verifying | Target Verifying | Done | Blocked
12
13
  - 范围(In scope):
13
14
  - 非目标(Out of scope):
14
- - 验收标准(必须可执行):
15
- - 依赖/约束:
16
- - 子任务:
15
+ - 是否高风险(Yes/No):
16
+ - 高风险分类(如有):DB / Auth / Payment / Jenkins / Gateway / Upload / Prod Config
17
+ - 影响面(API / DB / Jenkins / Page / Config / Deploy):
18
+ - 最小设计记录:
19
+ - 验收标准:
20
+ - 子任务(如有):
17
21
  - [ ] T0001-1 <subtask>
18
- - [ ] T0001-2 <subtask>
19
22
 
20
- ### 证据(完成后填写)
21
- - 项目配置:`docs/ENGINEERING.md`(frontmatter)
23
+ ### 默认证据(完成后填写)
24
+ - 项目配置:`docs/ENGINEERING.md`
25
+ - 提交:<commit sha>
26
+ - Jenkins Build:<build url>
27
+ - 目标环境验证:<health/api/page/business path>
28
+ - 闭环记录:`docs/tasks/closure-log.md`
29
+
30
+ ### 按需补充证据(仅在需要时填写)
22
31
  - DD:`docs/design/T0001-<slug>.md`
23
32
  - Review:`docs/reviews/T0001-YYYYMMDD-HHMM.md`
24
33
  - API 文档:`docs/interfaces/api.md`
25
34
  - API Change Log:`docs/interfaces/api-change-log.md`
26
- - 本地CI:粘贴摘要或给出文件路径
27
- - 本地 Compose 验证:命令输出或 Review 文档摘要
28
- - Jenkins 部署记录:`docs/deployment/deploy-records/T0001-YYYYMMDD.md`
29
- - 回归矩阵:`docs/testing/regression-matrix.md`(全量PASS,且每项必须有真实证据)
30
- - Bug清单(如有):`docs/bugs/bug-list.md`
31
- - 任务总结(强制):`docs/tasks/summaries/T0001.md`
35
+ - 回归矩阵:`docs/testing/regression-matrix.md`
36
+ - Bug 清单:`docs/bugs/bug-list.md`
37
+ - Task Summary:`docs/tasks/summaries/T0001.md`
38
+ - Deployment Record:`docs/deployment/deploy-records/T0001-YYYYMMDD.md`
32
39
 
33
40
  ---
34
41
 
@@ -1,11 +1,11 @@
1
- # Regression Matrix(本地 Compose 环境回归矩阵:必须全量 PASS,0 fail)
1
+ # Regression Matrix(按需回归记录,不是每个小改动的默认门禁)
2
2
 
3
- > 1. 仅记录当前真实实现,不要预填伪接口或目标态接口。
3
+ > 1. 只记录真实执行过的回归项。
4
4
  > 2. `Status` 允许值:`TODO` / `PASS` / `FAIL`。
5
- > 3. 新增或未执行项默认填写 `TODO`,不得预填 `PASS`。
6
- > 4. `PASS` 只允许在真实执行后填写,且 `Evidence` 不得保留占位符。
7
- > 5. `python3 docs/tools/autopipeline/ap.py check-matrix` 会把非 `PASS` 行和占位符证据视为未完成。
5
+ > 3. 未执行项保持 `TODO`,不得预填 `PASS`。
6
+ > 4. 只有真实执行并具备证据时,才允许填写 `PASS`。
7
+ > 5. `check-matrix` 只在显式要求完整回归时使用,不作为默认小改动门禁。
8
8
 
9
9
  | ID | Area | Endpoint/Feature | Test Type | Steps / Command | Expected | Status(TODO/PASS/FAIL) | Evidence |
10
10
  |---|---|---|---|---|---|---|---|
11
- | R-001 | API | <Endpoint or feature> | <smoke/regression/manual> | <command or manual steps> | <expected result> | TODO | <fill-with-log-path-screenshot-or-report> |
11
+ | R-001 | <Area> | <Endpoint or feature> | <manual/smoke/regression> | <command or manual steps> | <expected result> | TODO | <real log path / screenshot / report> |