coding-agent-harness 1.0.0
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.
- package/CHANGELOG.md +13 -0
- package/LICENSE +21 -0
- package/README.md +141 -0
- package/SKILL.md +423 -0
- package/docs-release/README.md +30 -0
- package/docs-release/architecture/overview.md +52 -0
- package/docs-release/guides/agent-installation.md +139 -0
- package/examples/minimal-project/.harness-capabilities.json +8 -0
- package/examples/minimal-project/AGENTS.md +4 -0
- package/examples/minimal-project/CLAUDE.md +3 -0
- package/examples/minimal-project/docs/09-PLANNING/TASKS/demo-task/execution_strategy.md +10 -0
- package/examples/minimal-project/docs/09-PLANNING/TASKS/demo-task/progress.md +11 -0
- package/examples/minimal-project/docs/09-PLANNING/TASKS/demo-task/review.md +27 -0
- package/examples/minimal-project/docs/09-PLANNING/TASKS/demo-task/task_plan.md +14 -0
- package/examples/minimal-project/docs/09-PLANNING/TASKS/demo-task/visual_roadmap.md +11 -0
- package/examples/minimal-project/docs/Harness-Ledger.md +6 -0
- package/package.json +34 -0
- package/references/adversarial-review-standard.md +173 -0
- package/references/agents-md-pattern.md +140 -0
- package/references/cadence-ledger.md +55 -0
- package/references/ci-cd-standard.md +90 -0
- package/references/delivery-operating-model-standard.md +145 -0
- package/references/docs-directory-standard.md +125 -0
- package/references/harness-ledger.md +148 -0
- package/references/lessons-governance.md +157 -0
- package/references/long-running-task-standard.md +209 -0
- package/references/module-parallel-standard.md +292 -0
- package/references/planning-loop.md +192 -0
- package/references/project-onboarding-audit.md +167 -0
- package/references/regression-system.md +89 -0
- package/references/repo-governance-standard.md +131 -0
- package/references/review-routing-standard.md +103 -0
- package/references/ssot-governance.md +111 -0
- package/references/walkthrough-closeout.md +135 -0
- package/references/worktree-parallel.md +184 -0
- package/scripts/check-harness.mjs +728 -0
- package/scripts/harness.mjs +201 -0
- package/scripts/lib/dashboard-writer.mjs +95 -0
- package/scripts/lib/harness-core.mjs +1318 -0
- package/scripts/smoke-dashboard.mjs +70 -0
- package/scripts/test-harness.mjs +482 -0
- package/templates/AGENTS.md.template +82 -0
- package/templates/CLAUDE.md.template +12 -0
- package/templates/dashboard/assets/app.css +399 -0
- package/templates/dashboard/assets/app.js +435 -0
- package/templates/dashboard/assets/i18n.js +47 -0
- package/templates/dashboard/assets/markdown-reader.js +116 -0
- package/templates/dashboard/assets/mermaid-renderer.js +59 -0
- package/templates/dashboard/index.html +18 -0
- package/templates/ledger/Harness-Ledger.md +39 -0
- package/templates/lessons/lesson-arch-process-change.md +47 -0
- package/templates/lessons/lesson-new-doc.md +50 -0
- package/templates/lessons/lesson-ref-change.md +45 -0
- package/templates/planning/execution_strategy.md +40 -0
- package/templates/planning/findings.md +24 -0
- package/templates/planning/long-running-task-contract.md +69 -0
- package/templates/planning/module_plan.md +36 -0
- package/templates/planning/module_session_prompt.md +39 -0
- package/templates/planning/optional/artifacts/INDEX.md +12 -0
- package/templates/planning/optional/references/INDEX.md +13 -0
- package/templates/planning/optional/slices/_slice-template/brief.md +27 -0
- package/templates/planning/optional/slices/_slice-template/evidence.md +9 -0
- package/templates/planning/optional/slices/_slice-template/review.md +31 -0
- package/templates/planning/progress.md +33 -0
- package/templates/planning/review.md +48 -0
- package/templates/planning/task_plan.md +86 -0
- package/templates/planning/visual_roadmap.md +28 -0
- package/templates/reference/adversarial-review-standard.md +28 -0
- package/templates/reference/ci-cd-standard.md +28 -0
- package/templates/reference/delivery-operating-model-standard.md +28 -0
- package/templates/reference/docs-library-standard.md +28 -0
- package/templates/reference/engineering-standard.md +29 -0
- package/templates/reference/execution-workflow-standard.md +29 -0
- package/templates/reference/harness-ledger-standard.md +26 -0
- package/templates/reference/long-running-task-standard.md +28 -0
- package/templates/reference/regression-ssot-governance.md +28 -0
- package/templates/reference/repo-governance-standard.md +29 -0
- package/templates/reference/review-routing-standard.md +29 -0
- package/templates/reference/testing-standard.md +28 -0
- package/templates/reference/walkthrough-standard.md +28 -0
- package/templates/reference/worktree-standard.md +28 -0
- package/templates/regression/Cadence-Ledger.md +41 -0
- package/templates/ssot/Delivery-SSoT.md +43 -0
- package/templates/ssot/Feature-SSoT.md +43 -0
- package/templates/ssot/Lessons-SSoT.md +44 -0
- package/templates/ssot/Module-Registry.md +43 -0
- package/templates/ssot/Regression-SSoT.md +51 -0
- package/templates/verifier/verifier-output.md +43 -0
- package/templates/walkthrough/Closeout-SSoT.md +43 -0
- package/templates/walkthrough/walkthrough-template.md +63 -0
- package/templates-zh-CN/AGENTS.md.template +92 -0
- package/templates-zh-CN/CLAUDE.md.template +12 -0
- package/templates-zh-CN/dashboard/assets/app.css +399 -0
- package/templates-zh-CN/dashboard/assets/app.js +435 -0
- package/templates-zh-CN/dashboard/assets/i18n.js +47 -0
- package/templates-zh-CN/dashboard/assets/markdown-reader.js +116 -0
- package/templates-zh-CN/dashboard/assets/mermaid-renderer.js +59 -0
- package/templates-zh-CN/dashboard/index.html +18 -0
- package/templates-zh-CN/ledger/Harness-Ledger.md +50 -0
- package/templates-zh-CN/lessons/lesson-arch-process-change.md +47 -0
- package/templates-zh-CN/lessons/lesson-new-doc.md +49 -0
- package/templates-zh-CN/lessons/lesson-ref-change.md +59 -0
- package/templates-zh-CN/planning/execution_strategy.md +37 -0
- package/templates-zh-CN/planning/findings.md +24 -0
- package/templates-zh-CN/planning/long-running-task-contract.md +118 -0
- package/templates-zh-CN/planning/module_plan.md +43 -0
- package/templates-zh-CN/planning/module_session_prompt.md +70 -0
- package/templates-zh-CN/planning/optional/artifacts/INDEX.md +13 -0
- package/templates-zh-CN/planning/optional/references/INDEX.md +13 -0
- package/templates-zh-CN/planning/optional/slices/_slice-template/brief.md +35 -0
- package/templates-zh-CN/planning/optional/slices/_slice-template/evidence.md +12 -0
- package/templates-zh-CN/planning/optional/slices/_slice-template/review.md +37 -0
- package/templates-zh-CN/planning/progress.md +29 -0
- package/templates-zh-CN/planning/review.md +69 -0
- package/templates-zh-CN/planning/task_plan.md +116 -0
- package/templates-zh-CN/planning/visual_roadmap.md +24 -0
- package/templates-zh-CN/reference/adversarial-review-standard.md +89 -0
- package/templates-zh-CN/reference/ci-cd-standard.md +72 -0
- package/templates-zh-CN/reference/delivery-operating-model-standard.md +79 -0
- package/templates-zh-CN/reference/docs-library-standard.md +59 -0
- package/templates-zh-CN/reference/engineering-standard.md +80 -0
- package/templates-zh-CN/reference/execution-workflow-standard.md +81 -0
- package/templates-zh-CN/reference/harness-ledger-standard.md +91 -0
- package/templates-zh-CN/reference/long-running-task-standard.md +156 -0
- package/templates-zh-CN/reference/regression-ssot-governance.md +82 -0
- package/templates-zh-CN/reference/repo-governance-standard.md +84 -0
- package/templates-zh-CN/reference/review-routing-standard.md +82 -0
- package/templates-zh-CN/reference/testing-standard.md +72 -0
- package/templates-zh-CN/reference/walkthrough-standard.md +83 -0
- package/templates-zh-CN/reference/worktree-standard.md +116 -0
- package/templates-zh-CN/regression/Cadence-Ledger.md +48 -0
- package/templates-zh-CN/ssot/Delivery-SSoT.md +60 -0
- package/templates-zh-CN/ssot/Feature-SSoT.md +49 -0
- package/templates-zh-CN/ssot/Lessons-SSoT.md +49 -0
- package/templates-zh-CN/ssot/Module-Registry.md +48 -0
- package/templates-zh-CN/ssot/Regression-SSoT.md +51 -0
- package/templates-zh-CN/verifier/verifier-output.md +38 -0
- package/templates-zh-CN/walkthrough/Closeout-SSoT.md +42 -0
- package/templates-zh-CN/walkthrough/walkthrough-template.md +62 -0
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Module Registry
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Track module ownership, write scope, branch or worktree assignment, and coordinator sync state for parallel agent work.
|
|
6
|
+
|
|
7
|
+
## Status Legend
|
|
8
|
+
|
|
9
|
+
| Status | Meaning | Required Next Step |
|
|
10
|
+
| --- | --- | --- |
|
|
11
|
+
| unassigned | Module exists but has no active owner. | Assign owner before work starts. |
|
|
12
|
+
| reserved | Owner and scope are assigned. | Open worktree or begin planning. |
|
|
13
|
+
| active | Module work is in progress. | Keep branch, plan, and blockers current. |
|
|
14
|
+
| handoff | Worker has produced a reviewable result. | Coordinator reviews and integrates. |
|
|
15
|
+
| merged | Module changes are integrated. | Link merge evidence and close residuals. |
|
|
16
|
+
| blocked | Module cannot proceed. | Record blocker owner and unblock condition. |
|
|
17
|
+
| archived | Module assignment is historical. | Keep archive pointer if needed. |
|
|
18
|
+
|
|
19
|
+
## Active Modules
|
|
20
|
+
|
|
21
|
+
| ID | Module | Path Scope | Owner | Status | Branch or Worktree | Task Plan | Shared Files | Depends On | Handoff Evidence | Residual | Updated |
|
|
22
|
+
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
23
|
+
| M-000 | Module title | src/module/** or docs/area/** | owner | reserved | branch or worktree path | docs/09-PLANNING/TASKS/.../task_plan.md | none | none | pending | none | YYYY-MM-DD |
|
|
24
|
+
|
|
25
|
+
## Shared-File Register
|
|
26
|
+
|
|
27
|
+
| File | Current Owner | Coordination Rule | Active Consumers | Last Sync |
|
|
28
|
+
| --- | --- | --- | --- | --- |
|
|
29
|
+
| path/to/shared-file | coordinator | only coordinator edits, workers propose patches | M-000, M-001 | YYYY-MM-DD |
|
|
30
|
+
|
|
31
|
+
## Routing Rules
|
|
32
|
+
|
|
33
|
+
1. Define module path scope before assigning a worker.
|
|
34
|
+
2. Workers must not edit outside their assigned scope without coordinator approval.
|
|
35
|
+
3. Shared files need an explicit owner and sync rule before parallel work starts.
|
|
36
|
+
4. Move a module to `handoff` only when the worker provides evidence, residuals, and integration notes.
|
|
37
|
+
5. The coordinator owns final merge, shared-file reconciliation, and Delivery SSoT updates.
|
|
38
|
+
|
|
39
|
+
## Archive Rules
|
|
40
|
+
|
|
41
|
+
- Keep active, blocked, and handoff rows visible until integration completes.
|
|
42
|
+
- Archive merged module rows after the delivery or release closeout is stable.
|
|
43
|
+
- Preserve branch, worktree, task plan, and handoff evidence in the archive row.
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Regression SSoT
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Define the project regression gates and record their current evidence state. This file decides which checks are required before a feature, delivery, or release can close.
|
|
6
|
+
|
|
7
|
+
## Status Legend
|
|
8
|
+
|
|
9
|
+
| Status | Meaning | Required Next Step |
|
|
10
|
+
| --- | --- | --- |
|
|
11
|
+
| draft | Gate is proposed but not enforced. | Define scope, command, owner, and pass criteria. |
|
|
12
|
+
| active | Gate is required for matching changes. | Run on cadence or when triggered. |
|
|
13
|
+
| failing | Latest required run failed. | Assign fix owner and block affected closeout. |
|
|
14
|
+
| waived | Gate is skipped for a specific reason. | Record approver, expiry, and compensating evidence. |
|
|
15
|
+
| retired | Gate is no longer valid. | Link replacement or retirement rationale. |
|
|
16
|
+
| archived | Gate is historical. | Preserve final state and replacement pointer. |
|
|
17
|
+
|
|
18
|
+
## Regression Gates
|
|
19
|
+
|
|
20
|
+
| ID | Gate | Applies To | Owner | Status | Command or Procedure | Evidence Depth | Pass Criteria | Latest Evidence | Blocks Closeout | Updated |
|
|
21
|
+
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
22
|
+
| RG-000 | Gate title | feature, module, route, API, release | owner | active | command or manual procedure | E1/E2/E3 | objective pass condition | path, log, screenshot, or CI run | yes | YYYY-MM-DD |
|
|
23
|
+
|
|
24
|
+
## Evidence Depth
|
|
25
|
+
|
|
26
|
+
| Level | Meaning | Examples |
|
|
27
|
+
| --- | --- | --- |
|
|
28
|
+
| E0 | Declared only; not acceptable for closeout. | "Not run", unchecked assumption. |
|
|
29
|
+
| E1 | Static or local check. | Typecheck, lint, unit test, parser check. |
|
|
30
|
+
| E2 | Runtime behavior check. | Browser smoke, API probe, integration test, CLI dry run. |
|
|
31
|
+
| E3 | End-to-end or production-like check. | Full workflow, deployed environment, real data with redaction. |
|
|
32
|
+
|
|
33
|
+
## Waivers
|
|
34
|
+
|
|
35
|
+
| Gate | Scope | Reason | Approver | Compensating Evidence | Expires |
|
|
36
|
+
| --- | --- | --- | --- | --- | --- |
|
|
37
|
+
| RG-000 | feature, PR, or release | reason | owner | alternate command or review | YYYY-MM-DD |
|
|
38
|
+
|
|
39
|
+
## Routing Rules
|
|
40
|
+
|
|
41
|
+
1. Every active gate must have an owner, trigger scope, and pass criteria.
|
|
42
|
+
2. Any feature or delivery closeout must cite the gates it ran or the waiver that covers the gap.
|
|
43
|
+
3. Mark a gate `failing` when the latest required run fails, even if the failure is believed unrelated.
|
|
44
|
+
4. Waivers must be narrow, dated, and paired with compensating evidence.
|
|
45
|
+
5. Retire a gate only after its replacement or rationale is recorded.
|
|
46
|
+
|
|
47
|
+
## Archive Rules
|
|
48
|
+
|
|
49
|
+
- Keep active, failing, and waived gates in this file.
|
|
50
|
+
- Move retired gates to the archive after consumers have been updated.
|
|
51
|
+
- Preserve old gate IDs when archiving so historical walkthroughs remain traceable.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Verifier Output
|
|
2
|
+
|
|
3
|
+
## Verifier Metadata
|
|
4
|
+
|
|
5
|
+
- template_id: harness-verifier/v1
|
|
6
|
+
- verifier: agent, tool, or human name
|
|
7
|
+
- target: task, pull request, release, module, or document set
|
|
8
|
+
- verdict: pass / fail / inconclusive
|
|
9
|
+
- date: YYYY-MM-DD
|
|
10
|
+
|
|
11
|
+
## Scope Checked
|
|
12
|
+
|
|
13
|
+
| Area | Included? | Evidence |
|
|
14
|
+
| --- | --- | --- |
|
|
15
|
+
| Implementation scope | yes / no | files, diff, commit, or PR |
|
|
16
|
+
| Tests and regression | yes / no | commands, CI runs, logs, screenshots |
|
|
17
|
+
| SSoT and ledger updates | yes / no | Feature, Delivery, Regression, Closeout, or Harness Ledger links |
|
|
18
|
+
| Review disposition | yes / no | review path, finding IDs, or no-finding statement |
|
|
19
|
+
| Lessons and references | yes / no | Lessons SSoT, detail doc, or checked-none reason |
|
|
20
|
+
|
|
21
|
+
## Explicit Exclusions
|
|
22
|
+
|
|
23
|
+
| Exclusion | Reason | Risk |
|
|
24
|
+
| --- | --- | --- |
|
|
25
|
+
| Scope not checked | why it was excluded | low / medium / high |
|
|
26
|
+
|
|
27
|
+
## Findings
|
|
28
|
+
|
|
29
|
+
| ID | Severity | Finding | Evidence Checked | Required Action | Open | Disposition | Blocks Release | Follow-up |
|
|
30
|
+
| --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
31
|
+
|
|
32
|
+
Allowed `Disposition` values: `open`, `mitigated`, `closed`, `deferred`, `accepted-risk`, `not-reproducible`, `out-of-scope`.
|
|
33
|
+
Do not keep sample findings. If there are no findings, leave only the header and explain the no-finding basis in `Final Confidence Basis`.
|
|
34
|
+
|
|
35
|
+
## Residual Routing
|
|
36
|
+
|
|
37
|
+
| Residual | Owner | Due | Accepted? | Link |
|
|
38
|
+
| --- | --- | --- | --- | --- |
|
|
39
|
+
| risk or `none` | owner | YYYY-MM-DD or n/a | yes / no / n/a | issue, SSoT row, or none |
|
|
40
|
+
|
|
41
|
+
## Final Confidence Basis
|
|
42
|
+
|
|
43
|
+
State the concrete evidence that justifies the verdict. Include the strongest checks run, the most important exclusions, and why any residual risk is acceptable or blocking.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Closeout SSoT
|
|
2
|
+
|
|
3
|
+
## Purpose
|
|
4
|
+
|
|
5
|
+
Track whether planned work has completed the required closeout contract: implementation evidence, regression evidence, review disposition, walkthrough, residual routing, lessons check, and ledger update.
|
|
6
|
+
|
|
7
|
+
## Status Legend
|
|
8
|
+
|
|
9
|
+
| Status | Meaning | Required Next Step |
|
|
10
|
+
| --- | --- | --- |
|
|
11
|
+
| open | Work is not ready for closeout. | Continue implementation or evidence collection. |
|
|
12
|
+
| evidence | Implementation is done but verification is incomplete. | Run required checks and attach evidence. |
|
|
13
|
+
| review | Evidence exists and review is pending. | Resolve findings or record `accepted-risk`. |
|
|
14
|
+
| closing | Final walkthrough and ledger updates are in progress. | Finish lessons check and routing. |
|
|
15
|
+
| closed | Closeout contract is complete. | Archive after the retention window. |
|
|
16
|
+
| blocked | Closeout cannot finish. | Record blocker owner and unblock condition. |
|
|
17
|
+
| archived | Closeout is historical. | Keep archive pointer. |
|
|
18
|
+
|
|
19
|
+
## Active Closeouts
|
|
20
|
+
|
|
21
|
+
| ID | Work Item | Owner | Status | Implementation Evidence | Regression Evidence | Review Disposition | Walkthrough | Lessons Check | Harness Ledger | Residual | Updated |
|
|
22
|
+
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |
|
|
23
|
+
| CO-YYYY-MM-DD-001 | F-000 or D-000 title | owner | [open / closed / blocked] | path or pending | RG-000 or pending | pending | pending | pending | HL-000 | none | YYYY-MM-DD |
|
|
24
|
+
|
|
25
|
+
## Release-Blocking Residuals
|
|
26
|
+
|
|
27
|
+
| Residual | Source | Owner | Blocks Release? | Decision | Due |
|
|
28
|
+
| --- | --- | --- | --- | --- | --- |
|
|
29
|
+
| risk or unresolved finding | review, regression, or walkthrough | owner | yes / no | fix, accept, defer, or waive | YYYY-MM-DD |
|
|
30
|
+
|
|
31
|
+
## Routing Rules
|
|
32
|
+
|
|
33
|
+
1. Every shipped feature, delivery, release, and harness update needs a closeout row.
|
|
34
|
+
2. Move to `closed` only after walkthrough, regression evidence, review disposition, lessons check, and Harness Ledger link are complete.
|
|
35
|
+
3. `not run` verification is a residual, not a pass.
|
|
36
|
+
4. Release-blocking residuals must stay visible until fixed, accepted by an owner, or moved to a follow-up with a due date.
|
|
37
|
+
5. Closeout rows should link durable files rather than summarize chat decisions.
|
|
38
|
+
|
|
39
|
+
## Archive Rules
|
|
40
|
+
|
|
41
|
+
- Keep open, evidence, review, closing, and blocked rows in this file.
|
|
42
|
+
- Archive closed rows after the next release or maintenance cycle.
|
|
43
|
+
- Preserve final evidence, walkthrough, lessons check, residual decision, and archive date.
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# Walkthrough: Short Task or Release Title
|
|
2
|
+
|
|
3
|
+
## Summary
|
|
4
|
+
|
|
5
|
+
One sentence describing what changed and why it matters.
|
|
6
|
+
|
|
7
|
+
## Scope
|
|
8
|
+
|
|
9
|
+
| Area | Details |
|
|
10
|
+
| --- | --- |
|
|
11
|
+
| Changed modules | List paths or module IDs. |
|
|
12
|
+
| New files | List files or `none`. |
|
|
13
|
+
| Removed files | List files or `none`. |
|
|
14
|
+
| Out of scope | List explicitly excluded work. |
|
|
15
|
+
|
|
16
|
+
## Decisions
|
|
17
|
+
|
|
18
|
+
| Decision | Choice | Reason | Owner |
|
|
19
|
+
| --- | --- | --- | --- |
|
|
20
|
+
| Decision title | Selected option | Why this choice is acceptable | owner |
|
|
21
|
+
|
|
22
|
+
## Verification
|
|
23
|
+
|
|
24
|
+
| Check | Command or Procedure | Result | Evidence |
|
|
25
|
+
| --- | --- | --- | --- |
|
|
26
|
+
| Unit, integration, browser, CI, or manual check | command or procedure | pass / fail / not run | path, log, screenshot, or reason |
|
|
27
|
+
|
|
28
|
+
## Regression Linkage
|
|
29
|
+
|
|
30
|
+
| Gate | Required? | Result | Evidence Depth | Notes |
|
|
31
|
+
| --- | --- | --- | --- | --- |
|
|
32
|
+
| RG-000 | yes / no | pass / fail / waived / not run | E0/E1/E2/E3 | link to Regression SSoT or waiver |
|
|
33
|
+
|
|
34
|
+
## Review Disposition
|
|
35
|
+
|
|
36
|
+
| Source | Material Findings | Resolution | Evidence |
|
|
37
|
+
| --- | --- | --- | --- |
|
|
38
|
+
| reviewer, verifier, CI, or self-review | none / finding IDs | closed / mitigated / accepted-risk / out-of-scope / n/a | review path or note |
|
|
39
|
+
|
|
40
|
+
## Residual Risk
|
|
41
|
+
|
|
42
|
+
| Risk | Owner | Accepted? | Follow-up |
|
|
43
|
+
| --- | --- | --- | --- |
|
|
44
|
+
| none | owner | n/a | none |
|
|
45
|
+
|
|
46
|
+
## Lessons Reflection
|
|
47
|
+
|
|
48
|
+
| Question | Answer |
|
|
49
|
+
| --- | --- |
|
|
50
|
+
| Did this reveal a reusable reference, workflow, or checker gap? | yes / no, reason |
|
|
51
|
+
| Could a future agent repeat the same mistake? | yes / no, reason |
|
|
52
|
+
| Was a lesson created or updated? | L-YYYY-MM-DD-001 or checked-none: reason |
|
|
53
|
+
| Lessons detail doc | path or none |
|
|
54
|
+
|
|
55
|
+
## Closeout Links
|
|
56
|
+
|
|
57
|
+
| Artifact | Link |
|
|
58
|
+
| --- | --- |
|
|
59
|
+
| Task plan | docs/09-PLANNING/TASKS/.../task_plan.md |
|
|
60
|
+
| Feature or Delivery SSoT | F-000 or D-000 |
|
|
61
|
+
| Harness Ledger | HL-YYYY-MM-DD-001 |
|
|
62
|
+
| Closeout SSoT | CO-YYYY-MM-DD-001 |
|
|
63
|
+
| Pull request or commit | link or hash |
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# [项目名称]
|
|
2
|
+
|
|
3
|
+
> Agent 进入本仓库时先读这个文件。它负责说明项目边界、工作顺序和文档入口,不承载所有细节。
|
|
4
|
+
|
|
5
|
+
## 项目概况
|
|
6
|
+
|
|
7
|
+
- **项目名**:[项目名称]
|
|
8
|
+
- **技术栈**:[语言 / 框架 / 运行时]
|
|
9
|
+
- **仓库形态**:[单仓 / monorepo / 多仓协作]
|
|
10
|
+
- **主要模块**:[列出主要子项目、包或服务]
|
|
11
|
+
- **默认分支**:[例如 `main`]
|
|
12
|
+
|
|
13
|
+
## 不可违反的规则
|
|
14
|
+
|
|
15
|
+
1. [架构约束,例如:外部依赖必须通过 adapter 层隔离]
|
|
16
|
+
2. [安全约束,例如:不得提交密钥、令牌、用户隐私数据]
|
|
17
|
+
3. [流程约束,例如:非平凡任务必须先建立任务目录和计划文件]
|
|
18
|
+
4. [发布约束,例如:未通过指定回归门禁不得合并或发布]
|
|
19
|
+
|
|
20
|
+
## 任务阅读矩阵
|
|
21
|
+
|
|
22
|
+
按任务类型读取最少但足够的上下文。不要一次性加载整套文档。
|
|
23
|
+
|
|
24
|
+
| 任务类型 | 先读文件 |
|
|
25
|
+
| --- | --- |
|
|
26
|
+
| 架构、核心模块、跨模块改动 | `docs/11-REFERENCE/engineering-standard.md` |
|
|
27
|
+
| 测试、冒烟、回归 | `docs/11-REFERENCE/testing-standard.md` |
|
|
28
|
+
| 开发执行、提交、PR | `docs/11-REFERENCE/execution-workflow-standard.md` |
|
|
29
|
+
| 多人协作、多仓交付、前后端分工 | `docs/11-REFERENCE/delivery-operating-model-standard.md`,再读 `docs/09-PLANNING/Delivery-SSoT.md` |
|
|
30
|
+
| 仓库治理、PR 规则、分支保护 | `docs/11-REFERENCE/repo-governance-standard.md` |
|
|
31
|
+
| CI/CD、必跑检查、发布门禁 | `docs/11-REFERENCE/ci-cd-standard.md` |
|
|
32
|
+
| 长程任务、连续执行、子代理审查 | `docs/11-REFERENCE/long-running-task-standard.md` |
|
|
33
|
+
| 对抗性审查、reviewer 报告 | `docs/11-REFERENCE/adversarial-review-standard.md` |
|
|
34
|
+
| reviewer、subagent、外部审查路由 | `docs/11-REFERENCE/review-routing-standard.md` |
|
|
35
|
+
| 文档治理、planning、任务目录 | `docs/11-REFERENCE/docs-library-standard.md` |
|
|
36
|
+
| Harness Ledger 回写 | `docs/11-REFERENCE/harness-ledger-standard.md` |
|
|
37
|
+
| Regression SSoT 维护 | `docs/11-REFERENCE/regression-ssot-governance.md` |
|
|
38
|
+
| 收口记录、Closeout、Lessons | `docs/11-REFERENCE/walkthrough-standard.md`,再读 `docs/01-GOVERNANCE/Lessons-SSoT.md` 与 `docs/10-WALKTHROUGH/Closeout-SSoT.md` |
|
|
39
|
+
| Worktree、并行开发、worker 隔离 | `docs/11-REFERENCE/worktree-standard.md` |
|
|
40
|
+
| [前端任务] | `docs/11-REFERENCE/frontend-standard.md` |
|
|
41
|
+
| [API 任务] | `docs/11-REFERENCE/api-standard.md` |
|
|
42
|
+
|
|
43
|
+
## 标准执行流程
|
|
44
|
+
|
|
45
|
+
1. 判断任务是否非平凡;非平凡任务先在 `docs/09-PLANNING/TASKS/` 建任务目录。
|
|
46
|
+
2. 填写 `task_plan.md`,并补齐同级 `execution_strategy.md` 与 `visual_roadmap.md`。
|
|
47
|
+
3. 确认本任务的 delivery operating model;涉及多人、多仓或共享交付时更新 Delivery SSoT。
|
|
48
|
+
4. 如果任务可能长时间连续执行,先填写 `long-running-task-contract.md`。
|
|
49
|
+
5. 如需 reviewer、subagent、release review,在任务目录维护 `review.md`。
|
|
50
|
+
6. 涉及合并、PR、CI 或发布时,先读仓库治理和 CI/CD 标准。
|
|
51
|
+
7. 根据任务类型回写功能 SSoT、Delivery SSoT 或 Regression SSoT。
|
|
52
|
+
8. 按 worktree 标准创建独立 worktree、feature branch、contract branch 或 release branch。
|
|
53
|
+
9. 实现后运行约定检查和回归门禁,并把证据写入 `progress.md` 或 artifacts index。
|
|
54
|
+
10. 收口前按 `review-routing-standard.md` 触发所需审查,处理所有阻塞发现。
|
|
55
|
+
11. 写 walkthrough,并引用任务计划、证据、审查结论和残余风险。
|
|
56
|
+
12. 执行 Lessons 检查:有可复用经验则写入 `docs/01-GOVERNANCE/lessons/` 并更新 Lessons SSoT;无经验也要记录 `checked-none: <原因>`。
|
|
57
|
+
13. 更新 `docs/10-WALKTHROUGH/Closeout-SSoT.md` 与 `docs/Harness-Ledger.md`。
|
|
58
|
+
14. 清理已完成并合并的 worktree。
|
|
59
|
+
|
|
60
|
+
## 子代理 / Worker 规则
|
|
61
|
+
|
|
62
|
+
主 agent 作为 coordinator 调用 subagent、外部 agent 或 reviewer 时,必须先判断对方角色。
|
|
63
|
+
|
|
64
|
+
- `reviewer`:默认只读,只能写审查报告、findings 或 `review.md`,不得直接改业务代码。
|
|
65
|
+
- `worker`:凡是会改代码、测试、产品文档或 harness 文档的 subagent,都必须在独立 worktree 和分支内工作。
|
|
66
|
+
|
|
67
|
+
Worker 的最低交付合同:
|
|
68
|
+
|
|
69
|
+
1. coordinator 先分配 worktree 路径、分支名、任务目录和允许写入范围。
|
|
70
|
+
2. worker 只在自己的 worktree 内编辑,不写 coordinator 当前 checkout。
|
|
71
|
+
3. worker 完成后运行约定检查,并提交自己的改动。
|
|
72
|
+
4. worker handoff 必须包含 worktree path、branch、commit SHA、checks、residual risks。
|
|
73
|
+
5. coordinator 只集成 worker 的 commit,不把多个 worker 的未提交改动混在同一个 checkout。
|
|
74
|
+
6. coordinator 合并后运行最终回归,并更新 walkthrough、Harness Ledger 和 Lessons。
|
|
75
|
+
|
|
76
|
+
如果环境或用户明确要求不使用独立 worktree,必须在 `progress.md`、walkthrough 或 Harness Ledger 记录偏离原因、风险和补偿验证。
|
|
77
|
+
|
|
78
|
+
## SSoT 与总账
|
|
79
|
+
|
|
80
|
+
- **功能 SSoT**:`docs/09-PLANNING/[功能-SSoT].md`
|
|
81
|
+
- **Delivery SSoT**:`docs/09-PLANNING/Delivery-SSoT.md`
|
|
82
|
+
- **Regression SSoT**:`docs/05-TEST-QA/Regression-SSoT.md`
|
|
83
|
+
- **Lessons SSoT**:`docs/01-GOVERNANCE/Lessons-SSoT.md`
|
|
84
|
+
- **Cadence Ledger**:`docs/05-TEST-QA/Cadence-Ledger.md`
|
|
85
|
+
- **Harness Ledger**:`docs/Harness-Ledger.md`
|
|
86
|
+
- **Closeout SSoT**:`docs/10-WALKTHROUGH/Closeout-SSoT.md`
|
|
87
|
+
- **仓库治理标准**:`docs/11-REFERENCE/repo-governance-standard.md`
|
|
88
|
+
- **CI/CD 标准**:`docs/11-REFERENCE/ci-cd-standard.md`
|
|
89
|
+
|
|
90
|
+
## 协作补充
|
|
91
|
+
|
|
92
|
+
[按项目实际填写:模块 owner、共享文件锁、merge 顺序、发布审批人、环境限制等。]
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# 中文项目入口(Claude Code)
|
|
2
|
+
|
|
3
|
+
本项目以 `AGENTS.md` 作为 coding agent 指令的唯一权威入口。
|
|
4
|
+
|
|
5
|
+
Claude Code 开始任何任务前应当:
|
|
6
|
+
|
|
7
|
+
1. 先读取 `AGENTS.md`。
|
|
8
|
+
2. 按 `AGENTS.md` 的任务阅读矩阵选择当前任务需要的文件。
|
|
9
|
+
3. 只加载必要的 `docs/11-REFERENCE/` 标准文件和任务目录上下文。
|
|
10
|
+
4. 把本文件视为 Claude Code 兼容入口,而不是第二份项目规范。
|
|
11
|
+
|
|
12
|
+
不要在这里复制项目规则。长期有效的项目指令应维护在 `AGENTS.md` 及其引用文档中,避免两套规则逐渐漂移。
|