@pzy560117/codex-harness 0.1.3 → 0.1.5
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/README.md +164 -27
- package/bin/harness.js +7 -7
- package/lib/commands/doctor.js +12 -12
- package/lib/commands/init.js +105 -105
- package/lib/commands/run.js +22 -22
- package/lib/commands/verify.js +12 -12
- package/lib/main.js +62 -62
- package/lib/powershell/find-powershell.js +20 -20
- package/lib/powershell/invoke-script.js +34 -34
- package/lib/project/assert-initialized.js +20 -20
- package/lib/project/detect-project-root.js +5 -5
- package/lib/release/cache-layout.js +34 -34
- package/lib/release/download-release.js +25 -25
- package/lib/release/package-source-layout.js +13 -13
- package/lib/release/release-config.js +6 -6
- package/lib/release/release-manifest.js +76 -76
- package/lib/release/resolve-package-source.js +21 -21
- package/lib/release/resolve-version.js +26 -26
- package/lib/release/unpack-zip.js +25 -25
- package/lib/release/verify-sha256.js +16 -16
- package/package-source/AGENTS.md +48 -57
- package/package-source/PACKAGE.md +7 -7
- package/package-source/README.md +85 -81
- package/package-source/docs/codex-harness-engineering/templates/AGENTS.md +51 -0
- package/package-source/docs/codex-harness-engineering/templates/README.md +21 -20
- package/package-source/docs/codex-harness-engineering/templates/bootstrap-codex-harness.ps1 +144 -110
- package/package-source/docs/codex-harness-engineering/templates/ci/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/ci/github-action-codex-review.yml +110 -110
- package/package-source/docs/codex-harness-engineering/templates/config/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/config/agents/architect.toml +18 -17
- package/package-source/docs/codex-harness-engineering/templates/config/agents/backend-worker.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/docs-researcher.toml +13 -12
- package/package-source/docs/codex-harness-engineering/templates/config/agents/docs-worker.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/explorer.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/failure-triage.toml +19 -18
- package/package-source/docs/codex-harness-engineering/templates/config/agents/frontend-worker.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/harness-writer.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/planner.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/readonly-research.toml +14 -13
- package/package-source/docs/codex-harness-engineering/templates/config/agents/reviewer.toml +13 -12
- package/package-source/docs/codex-harness-engineering/templates/config/agents/security-reviewer.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/stage1-reviewer.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/stage2-reviewer.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/agents/test-planner.toml +18 -17
- package/package-source/docs/codex-harness-engineering/templates/config/agents/test-runner.toml +15 -14
- package/package-source/docs/codex-harness-engineering/templates/config/agents/visual-reviewer.toml +16 -15
- package/package-source/docs/codex-harness-engineering/templates/config/codex-agent-roles.md +24 -24
- package/package-source/docs/codex-harness-engineering/templates/config/codex-config.toml +12 -12
- package/package-source/docs/codex-harness-engineering/templates/config/codex-readme.md +6 -6
- package/package-source/docs/codex-harness-engineering/templates/config/env-check.ps1 +44 -40
- package/package-source/docs/codex-harness-engineering/templates/config/env.example +13 -12
- package/package-source/docs/codex-harness-engineering/templates/config/global-AGENTS.md +40 -40
- package/package-source/docs/codex-harness-engineering/templates/config/global-config.toml +19 -19
- package/package-source/docs/codex-harness-engineering/templates/config/rules/agents.md +118 -115
- package/package-source/docs/codex-harness-engineering/templates/config/rules/coding-style.md +57 -74
- package/package-source/docs/codex-harness-engineering/templates/config/rules/constitution.md +4 -4
- package/package-source/docs/codex-harness-engineering/templates/config/rules/git.rules +41 -41
- package/package-source/docs/codex-harness-engineering/templates/config/rules/harness.rules +29 -29
- package/package-source/docs/codex-harness-engineering/templates/config/rules/safety.rules +35 -35
- package/package-source/docs/codex-harness-engineering/templates/context/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/context/API_MAP.md +18 -0
- package/package-source/docs/codex-harness-engineering/templates/context/CHANGELOG_AI.md +11 -0
- package/package-source/docs/codex-harness-engineering/templates/context/CURRENT_TASK.md +114 -0
- package/package-source/docs/codex-harness-engineering/templates/context/DB_SCHEMA.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/context/DECISIONS.md +12 -0
- package/package-source/docs/codex-harness-engineering/templates/context/KNOWN_ISSUES.md +12 -0
- package/package-source/docs/codex-harness-engineering/templates/context/PROJECT_CONTEXT.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/context/architecture-brief.md +58 -58
- package/package-source/docs/codex-harness-engineering/templates/context/dev-plan.md +89 -83
- package/package-source/docs/codex-harness-engineering/templates/context/feature-pack.md +101 -101
- package/package-source/docs/codex-harness-engineering/templates/context/repo-map.md +102 -78
- package/package-source/docs/codex-harness-engineering/templates/context/service-dependency-matrix.yaml +25 -25
- package/package-source/docs/codex-harness-engineering/templates/contracts/AGENTS.md +17 -0
- package/package-source/docs/codex-harness-engineering/templates/contracts/README.md +24 -16
- package/package-source/docs/codex-harness-engineering/templates/contracts/openapi.yaml +182 -182
- package/package-source/docs/codex-harness-engineering/templates/contracts/orval.config.ts +20 -20
- package/package-source/docs/codex-harness-engineering/templates/contracts/prism-usage.md +41 -34
- package/package-source/docs/codex-harness-engineering/templates/design/AGENTS.md +21 -0
- package/package-source/docs/codex-harness-engineering/templates/design/ai-image-brief.md +122 -122
- package/package-source/docs/codex-harness-engineering/templates/design/component-map.md +45 -31
- package/package-source/docs/codex-harness-engineering/templates/design/design-brief.md +183 -178
- package/package-source/docs/codex-harness-engineering/templates/design/design-tokens.json +88 -88
- package/package-source/docs/codex-harness-engineering/templates/design/frontend-architecture.md +164 -146
- package/package-source/docs/codex-harness-engineering/templates/design/image-to-frontend-spec.md +64 -52
- package/package-source/docs/codex-harness-engineering/templates/design/screen-states.md +157 -122
- package/package-source/docs/codex-harness-engineering/templates/design/visual-parity-review.md +21 -21
- package/package-source/docs/codex-harness-engineering/templates/docs/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/architecture-constraints.md +97 -83
- package/package-source/docs/codex-harness-engineering/templates/docs/code-semantics-and-navigation.md +54 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/code-style-and-naming.md +116 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/directory-structure-template.md +88 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/env-and-deployment-template.md +60 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/frontend-quality-rules.md +165 -138
- package/package-source/docs/codex-harness-engineering/templates/docs/governance-auto-repair.md +82 -80
- package/package-source/docs/codex-harness-engineering/templates/docs/harness-architecture.md +78 -78
- package/package-source/docs/codex-harness-engineering/templates/docs/install-manifest-governance.md +16 -16
- package/package-source/docs/codex-harness-engineering/templates/docs/knowledge-architecture.md +241 -219
- package/package-source/docs/codex-harness-engineering/templates/docs/knowledge-import.md +108 -108
- package/package-source/docs/codex-harness-engineering/templates/docs/knowledge-lint.md +98 -98
- package/package-source/docs/codex-harness-engineering/templates/docs/mcp-knowledge-governance.md +24 -0
- package/package-source/docs/codex-harness-engineering/templates/docs/new-project-checklist.md +7 -7
- package/package-source/docs/codex-harness-engineering/templates/docs/new-project-usage.md +107 -43
- package/package-source/docs/codex-harness-engineering/templates/docs/project-agents-template.md +211 -154
- package/package-source/docs/codex-harness-engineering/templates/docs/prompt-knowledge-integration.md +100 -89
- package/package-source/docs/codex-harness-engineering/templates/docs/regression-rules.md +47 -45
- package/package-source/docs/codex-harness-engineering/templates/docs/requirement-prep-kit/README.md +3 -3
- package/package-source/docs/codex-harness-engineering/templates/docs/rule-governance.md +98 -98
- package/package-source/docs/codex-harness-engineering/templates/docs/service-dependency-matrix.md +70 -55
- package/package-source/docs/codex-harness-engineering/templates/docs/task-session-strategy.md +133 -116
- package/package-source/docs/codex-harness-engineering/templates/docs/team-knowledge-sync.md +187 -187
- package/package-source/docs/codex-harness-engineering/templates/docs/trace-format.md +44 -32
- package/package-source/docs/codex-harness-engineering/templates/governance/AGENTS.md +18 -0
- package/package-source/docs/codex-harness-engineering/templates/governance/branch-protection-checklist.md +50 -50
- package/package-source/docs/codex-harness-engineering/templates/governance/feedback-evolution-loop.md +55 -55
- package/package-source/docs/codex-harness-engineering/templates/governance/retry-budget.yaml +30 -30
- package/package-source/docs/codex-harness-engineering/templates/governance/risk-levels.yaml +53 -53
- package/package-source/docs/codex-harness-engineering/templates/governance/sandbox-policy.md +13 -13
- package/package-source/docs/codex-harness-engineering/templates/hooks/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/hooks/hook-stop-verify.ps1 +171 -118
- package/package-source/docs/codex-harness-engineering/templates/hooks/hooks.json +40 -40
- package/package-source/docs/codex-harness-engineering/templates/knowledge/AGENTS.md +16 -0
- package/package-source/docs/codex-harness-engineering/templates/knowledge/catalog.md +6 -6
- package/package-source/docs/codex-harness-engineering/templates/knowledge/decisions/DECISION-HARNESS-001.md +39 -39
- package/package-source/docs/codex-harness-engineering/templates/knowledge/guidelines/GUIDELINE-RULES-001.md +30 -30
- package/package-source/docs/codex-harness-engineering/templates/knowledge/knowledge-catalog.md +41 -41
- package/package-source/docs/codex-harness-engineering/templates/package-assets/.specify/templates/plan-template.md +252 -252
- package/package-source/docs/codex-harness-engineering/templates/package-assets/.specify/templates/spec-template.md +145 -145
- package/package-source/docs/codex-harness-engineering/templates/package-assets/.specify/templates/tasks-template.md +47 -47
- package/package-source/docs/codex-harness-engineering/templates/package-assets/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/AGENTS.md +25 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/README.md +118 -42
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/START-HERE.md +66 -53
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/agent-ecosystem-practices.md +140 -140
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/best-practices.md +9 -9
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/codex-global-rules-example.md +48 -48
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/goal-templates.md +380 -380
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/README.md +64 -64
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/contracts/openapi.yaml +25 -25
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/contracts/orval.config.ts +20 -20
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/ai-image-brief.md +44 -44
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/component-map.md +17 -17
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/design-brief.md +58 -58
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/frontend-architecture.md +106 -106
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/image-to-frontend-spec.md +72 -72
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/screen-states.md +25 -25
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/design/ui-image-review.md +38 -38
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/difficulty-research.md +39 -39
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/page-inventory.md +5 -5
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/prd-lite.md +41 -41
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/requirement-interface-matrix.md +32 -32
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/docs/product/state-matrix.yaml +14 -14
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/api-client/generated/model/Ticket.ts +6 -6
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/api-client/generated/ticket-api.ts +35 -35
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/api-client/http-client.ts +8 -8
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/packages/ui/TicketFilterBar.tsx +72 -72
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/plans/features/ticket-filter.dev-plan.md +48 -48
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/progress.txt +1 -1
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/stories/TicketFilterBar.stories.tsx +33 -33
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/task.json +54 -54
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/examples/ticket-filter-demo/verify.ps1 +42 -42
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/global-rules-and-bootstrap.md +157 -157
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/goal-harness-integration-guide.md +364 -364
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/implementation-flow.md +7 -5
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/implementation-guide.md +25 -25
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/knowledge-surface-map.md +186 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/mode-matrix.md +57 -57
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/new-project-usage.md +176 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/project-agents-template.md +168 -154
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/superpowers-codex-solo-builder-playbook.md +676 -676
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/AGENTS.md +22 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/API_MAP.md +18 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/CURRENT_TASK.md +89 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/context/dev-plan.md +166 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/contracts/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/contracts/README.md +24 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/contracts/prism-usage.md +41 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/component-map.md +45 -31
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/design-brief.md +183 -178
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/design-tokens.json +88 -88
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/frontend-architecture.md +164 -146
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/image-to-frontend-spec.md +64 -52
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/screen-states.md +157 -122
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/design/visual-parity-review.md +21 -21
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/env-and-deployment-template.md +60 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/frontend-quality-rules.md +161 -138
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/regression-rules.md +47 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/docs/trace-format.md +86 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/product/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/product/prd-lite.md +166 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/product/state-matrix.yaml +116 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/prompts/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/prompts/implement-one-task.md +150 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/prompts/repair-one-finding.md +70 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/spec/11-security-design.md +43 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/spec/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/EVIDENCE_PROTOCOL.md +54 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/NATURAL_LANGUAGE_TEST_CASES.md +690 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/REGRESSION_PLAN.md +28 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/TEST_STRATEGY.md +98 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/TRACEABILITY_MATRIX.md +23 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/codex-harness-engineering/templates/testing/verify-matrix.md +51 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/ecc-zh-CN/README.md +10 -10
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/ecc-zh-CN/commands/e2e.md +30 -30
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/README.md +60 -60
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/app/Mobile_App_Production_Readiness_Framework_/347/247/273/345/212/250/347/253/257/345/205/250/345/271/263/345/217/260/347/224/237/344/272/247/345/217/257/344/270/212/347/272/277/350/247/204/350/214/203.md +2457 -2457
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/app/catalog.md +33 -33
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/architecture.md +358 -358
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/common/AI_Coding_Production_Control_Framework_AI/345/206/231/345/256/214/347/232/204/344/273/243/347/240/201/345/246/202/344/275/225/344/270/215/345/244/261/346/216/247.md +2055 -2055
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/common/catalog.md +34 -34
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/initial-content.md +296 -296
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/external-knowledge/integration-roadmap.md +221 -221
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/architecture-constraints.md +95 -83
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/code-semantics-and-navigation.md +17 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/code-style-and-naming.md +116 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/frontend-quality-rules.md +138 -138
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/governance-auto-repair.md +82 -80
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/mcp-knowledge-governance.md +24 -0
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/service-dependency-matrix.md +55 -55
- package/package-source/docs/codex-harness-engineering/templates/package-assets/docs/harness/speckit-requirements-gate.md +124 -124
- package/package-source/docs/codex-harness-engineering/templates/package-assets/root/PACKAGE.md +7 -7
- package/package-source/docs/codex-harness-engineering/templates/package-assets/root/README.md +52 -52
- package/package-source/docs/codex-harness-engineering/templates/package-assets/root/install-agent-here.ps1 +57 -57
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/agents.md +115 -115
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/coding-style.md +57 -74
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/constitution.md +4 -4
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/git.rules +41 -41
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/harness.rules +29 -29
- package/package-source/docs/codex-harness-engineering/templates/package-assets/rules/safety.rules +35 -35
- package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/ai-workflow/check-ai-sync-drift.ps1 +205 -205
- package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/ai-workflow/sync-ai-config-to-targets.ps1 +826 -826
- package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/ai-workflow/sync-targets.example.json +35 -35
- package/package-source/docs/codex-harness-engineering/templates/package-assets/scripts/harness/harness-governance-check.ps1 +864 -366
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/HOW_TO_USE_SKILLS.md +79 -79
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/academic-mermaid-diagrams/SKILL.md +172 -172
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/ai-config-git-sync/SKILL.md +152 -152
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/ai-config-git-sync/references/command-recipes.md +92 -92
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/auto-commit/SKILL.md +324 -322
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/better-icons/SKILL.md +3 -3
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/SKILL.md +100 -100
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/references/windows-openrouter-clash-playbook.md +94 -94
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/scripts/diagnose-openrouter-route.ps1 +282 -282
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/claude-openrouter-clash-debug/scripts/ensure-openrouter-rule.ps1 +101 -101
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/fixing-metadata/SKILL.md +6 -6
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/frontend-design/SKILL.md +37 -37
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/git-xianyu-analyzer/SKILL.md +3 -3
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/harness-surface-sync/SKILL.md +204 -188
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/harness-surface-sync/references/current-repo-sync-matrix.md +150 -110
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/harness-surface-sync/references/stale-patterns.md +65 -65
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/init-autopilot/SKILL.md +17 -15
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/log-analysis-optimization/SKILL.md +5 -5
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/prd-writer-skill/SKILL.md +28 -28
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qa-e2e-planner/SKILL.md +11 -11
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qa-e2e-runner/SKILL.md +6 -6
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qa-mock-cleaner/SKILL.md +4 -4
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qoder-codex-api-config/SKILL.md +67 -67
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qoder-codex-api-config/agents/openai.yaml +7 -7
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/qoder-codex-api-config/scripts/configure-qoder-codex-api.ps1 +278 -278
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/requirements-design-template/SKILL.md +87 -87
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/skills-index.md +12 -12
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-analyze/SKILL.md +34 -34
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-checklist/SKILL.md +8 -8
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-clarify/SKILL.md +28 -28
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-e2e-tasks/SKILL.md +12 -12
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-implement/SKILL.md +37 -37
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-plan/SKILL.md +140 -138
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-specify/SKILL.md +100 -100
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-tasks/SKILL.md +86 -86
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/speckit-verify/SKILL.md +144 -142
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/SKILL.md +145 -143
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/references/current-repo-notes.md +42 -41
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/references/github-samples.md +33 -33
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/sync-project-root-docs/scripts/collect-root-doc-facts.ps1 +174 -145
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/ai-integrity-and-originality.md +191 -191
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/citation-templates.md +99 -99
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/final-checklist.md +60 -60
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/photographer-booking-paper.md +85 -85
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/test-result-templates.md +22 -22
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/thesis-writing/references/thesis-analysis-template.md +63 -63
- package/package-source/docs/codex-harness-engineering/templates/package-assets/skills/update-codemaps/SKILL.md +31 -31
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/README.md +15 -15
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.analyze.md +60 -60
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.checklist.md +8 -8
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.clarify.md +28 -28
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.e2e-testing.md +10 -10
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.implement.md +56 -56
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.plan.md +137 -134
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.specify.md +100 -100
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.tasks.md +86 -86
- package/package-source/docs/codex-harness-engineering/templates/package-assets/workflows/speckit.verify.md +130 -130
- package/package-source/docs/codex-harness-engineering/templates/product/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/product/acceptance-criteria.md +47 -47
- package/package-source/docs/codex-harness-engineering/templates/product/difficulty-research.md +47 -47
- package/package-source/docs/codex-harness-engineering/templates/product/page-inventory.md +21 -21
- package/package-source/docs/codex-harness-engineering/templates/product/prd-lite.md +166 -158
- package/package-source/docs/codex-harness-engineering/templates/product/requirement-interface-matrix.md +37 -37
- package/package-source/docs/codex-harness-engineering/templates/product/state-matrix.yaml +116 -105
- package/package-source/docs/codex-harness-engineering/templates/prompts/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/prompts/controller-loop.md +88 -88
- package/package-source/docs/codex-harness-engineering/templates/prompts/failure-triage.md +71 -69
- package/package-source/docs/codex-harness-engineering/templates/prompts/harness-audit.md +54 -52
- package/package-source/docs/codex-harness-engineering/templates/prompts/implement-one-task.md +150 -148
- package/package-source/docs/codex-harness-engineering/templates/prompts/repair-one-finding.md +70 -67
- package/package-source/docs/codex-harness-engineering/templates/prompts/review-one-task.md +45 -43
- package/package-source/docs/codex-harness-engineering/templates/prompts/review-stage1-spec.md +111 -109
- package/package-source/docs/codex-harness-engineering/templates/prompts/review-stage2-quality.md +82 -80
- package/package-source/docs/codex-harness-engineering/templates/prompts/visual-evaluator.md +80 -78
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/backend-worker.md +41 -41
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/docs-worker.md +28 -28
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/frontend-worker.md +46 -46
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/harness-writer.md +40 -40
- package/package-source/docs/codex-harness-engineering/templates/prompts/worker-role/test-runner.md +27 -27
- package/package-source/docs/codex-harness-engineering/templates/runtime/AGENTS.md +66 -50
- package/package-source/docs/codex-harness-engineering/templates/runtime/codex-loop.ps1 +2129 -231
- package/package-source/docs/codex-harness-engineering/templates/runtime/doctor.ps1 +224 -224
- package/package-source/docs/codex-harness-engineering/templates/runtime/project-task-template.json +42 -39
- package/package-source/docs/codex-harness-engineering/templates/runtime/scripts/test-install-modes.ps1 +2 -2
- package/package-source/docs/codex-harness-engineering/templates/runtime/smoke-task.json +52 -52
- package/package-source/docs/codex-harness-engineering/templates/runtime/task-run-profile.json +86 -86
- package/package-source/docs/codex-harness-engineering/templates/runtime/task.json +11 -8
- package/package-source/docs/codex-harness-engineering/templates/runtime/verify.ps1 +21 -21
- package/package-source/docs/codex-harness-engineering/templates/scripts/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/scripts/ai-workflow/check-ai-sync-drift.ps1 +205 -205
- package/package-source/docs/codex-harness-engineering/templates/scripts/harness/harness-governance-check.ps1 +864 -366
- package/package-source/docs/codex-harness-engineering/templates/spec/10-data-model.md +23 -7
- package/package-source/docs/codex-harness-engineering/templates/spec/11-security-design.md +30 -13
- package/package-source/docs/codex-harness-engineering/templates/spec/AGENTS.md +15 -0
- package/package-source/docs/codex-harness-engineering/templates/testing/ACCEPTANCE_CRITERIA.md +39 -39
- package/package-source/docs/codex-harness-engineering/templates/testing/ACCEPTANCE_EXAMPLES.md +37 -37
- package/package-source/docs/codex-harness-engineering/templates/testing/AGENTS.md +19 -0
- package/package-source/docs/codex-harness-engineering/templates/testing/EVIDENCE_PROTOCOL.md +54 -48
- package/package-source/docs/codex-harness-engineering/templates/testing/NATURAL_LANGUAGE_TEST_CASES.md +5 -4
- package/package-source/docs/codex-harness-engineering/templates/testing/REGRESSION_PLAN.md +28 -20
- package/package-source/docs/codex-harness-engineering/templates/testing/RISK_BASED_TEST_PLAN.md +16 -16
- package/package-source/docs/codex-harness-engineering/templates/testing/TEST_STRATEGY.md +98 -97
- package/package-source/docs/codex-harness-engineering/templates/testing/TRACEABILITY_MATRIX.md +6 -5
- package/package-source/docs/codex-harness-engineering/templates/testing/coverage-policy.md +25 -25
- package/package-source/docs/codex-harness-engineering/templates/testing/e2e-plan.md +139 -139
- package/package-source/docs/codex-harness-engineering/templates/testing/failure-findings.example.json +3 -3
- package/package-source/docs/codex-harness-engineering/templates/testing/failure-triage.md +62 -62
- package/package-source/docs/codex-harness-engineering/templates/testing/test-data-plan.md +36 -36
- package/package-source/docs/codex-harness-engineering/templates/testing/test-report.md +85 -41
- package/package-source/docs/codex-harness-engineering/templates/testing/verify-matrix.md +15 -5
- package/package-source/docs/codex-harness-engineering/templates/tools/AGENTS.md +14 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/acceptance-lint.ps1 +37 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/architecture-lint.ps1 +150 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/backend-lint.ps1 +137 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/business-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/component-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/config-lint.ps1 +159 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/context-lint.ps1 +187 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/contract-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/data-lint.ps1 +37 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/directory-lint.ps1 +152 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/docs-lint.ps1 +40 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/impact-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/integration-lint.ps1 +37 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/mobile-lint.ps1 +37 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/observability-lint.ps1 +137 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/performance-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/refactor-lint.ps1 +137 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/security-lint.ps1 +159 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/session-lint.ps1 +126 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/spec-lint.ps1 +285 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/state-lint.ps1 +137 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/style-lint.ps1 +155 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/testing-lint.ps1 +192 -0
- package/package-source/docs/codex-harness-engineering/templates/tools/harness/ui-lint.ps1 +148 -0
- package/package-source/docs/codex-harness-engineering/templates/trace/AGENTS.md +16 -0
- package/package-source/docs/codex-harness-engineering/templates/trace/eval-case.yaml +24 -24
- package/package-source/docs/codex-harness-engineering/templates/trace/trace.schema.json +101 -101
- package/package-source/install-manifest.json +149 -79
- package/package-source/tools/install/ai-workflow/check-ai-sync-drift.ps1 +205 -205
- package/package-source/tools/install/ai-workflow/sync-ai-config-to-targets.ps1 +826 -826
- package/package-source/tools/install/ai-workflow/sync-targets.example.json +35 -35
- package/package-source/tools/install/bootstrap-codex-harness.ps1 +145 -129
- package/package-source/tools/install/env-check.ps1 +40 -40
- package/package-source/tools/install/init-project.ps1 +1 -1
- package/package-source/tools/install/install-agent-here.ps1 +57 -57
- package/package-source/tools/install/install-agent.ps1 +33 -31
- package/package.json +23 -23
|
@@ -1,138 +1,161 @@
|
|
|
1
|
-
# Frontend Quality Rules
|
|
2
|
-
|
|
3
|
-
本文件定义前端页面从“能用”到“可交付”的最低质量尺子。它服务于 `spec-to-ui-to-code-workflow.md`、`design-brief.md`、`image-to-frontend-spec.md`、`component-map.md`、`screen-states.md` 和 `visual-parity-review.md`,不替代项目自己的品牌规范或产品需求。
|
|
4
|
-
|
|
5
|
-
## 1. 质量分级
|
|
6
|
-
|
|
7
|
-
| 等级 | 定义 | 必备证据 | 不能声称 |
|
|
8
|
-
| --- | --- | --- | --- |
|
|
9
|
-
| P0 可用 | 主路径能完成,关键控件可操作 | 主路径 story 或 E2E,基本截图 | 生产级体验 |
|
|
10
|
-
| P1 完整 | default / loading / empty / error / permission / long content / mobile 有规格和验证 | 状态矩阵、story 覆盖、移动端截图 | 视觉精修完成 |
|
|
11
|
-
| P2 精修 | 视觉层级、响应式、动效、可访问性和文案有明确标准并通过评审 | visual parity、a11y smoke、responsive matrix | 可无限复用 |
|
|
12
|
-
| P3 生产级 | 架构可维护,组件边界清晰,性能预算和回归证据完整 | frontend architecture、performance budget、regression evidence | 无需后续治理 |
|
|
13
|
-
|
|
14
|
-
`feature_impl` 的前端任务如果没有写明目标等级,默认按 P1 验收;用户可见核心流程默认至少 P2。
|
|
15
|
-
|
|
16
|
-
## 2. 审美反模式
|
|
17
|
-
|
|
18
|
-
以下情况出现任意一项,Stage 1 或视觉评审应要求返工,除非 Design Brief 明确说明原因:
|
|
19
|
-
|
|
20
|
-
- 页面只由大块卡片堆叠组成,缺少信息层级。
|
|
21
|
-
- 全页面灰白无重点,主要操作、危险操作和状态反馈不可区分。
|
|
22
|
-
- 使用无意义渐变、装饰图形或营销式 hero 来包装操作型后台页面。
|
|
23
|
-
- 所有按钮、标签、状态、表格行的视觉权重相同。
|
|
24
|
-
- 表格密度失控:行高、列宽、数字、标签和操作区没有扫描节奏。
|
|
25
|
-
- 移动端只做横向滚动,没有重排、折叠或卡片化策略。
|
|
26
|
-
- loading / empty / error 只是一行临时文案,没有恢复路径。
|
|
27
|
-
- 图标、颜色或动画只起装饰作用,不能帮助识别状态或操作。
|
|
28
|
-
|
|
29
|
-
## 3. 动效规则
|
|
30
|
-
|
|
31
|
-
动效必须解释状态变化,不承担主要信息表达。
|
|
32
|
-
|
|
33
|
-
| 场景 | 推荐动效 | 时长 | 约束 |
|
|
34
|
-
| --- | --- | --- | --- |
|
|
35
|
-
| 弹窗 / 抽屉打开 | opacity + scale 或 translate | 120-180ms | 必须有焦点管理 |
|
|
36
|
-
| 筛选 chip 增删 | opacity + slight translate | 100-160ms | 不得推动整页大范围跳动 |
|
|
37
|
-
| 表格刷新 | skeleton / row fade | 120-220ms | 高频刷新时禁用行级动画 |
|
|
38
|
-
| 空态 / 错误态切换 | opacity | 120-180ms | 文案和恢复操作优先 |
|
|
39
|
-
| 保存成功 / dirty 清除 | button state + inline status | 120-180ms | 不得只依赖 toast |
|
|
40
|
-
|
|
41
|
-
硬约束:
|
|
42
|
-
|
|
43
|
-
- 首选 `transform` 和 `opacity`,不得用会持续触发布局的动画属性。
|
|
44
|
-
- 必须支持 `prefers-reduced-motion` 或等价 reduced motion 开关。
|
|
45
|
-
- 动效不能隐藏错误、禁用、权限不足或保存失败。
|
|
46
|
-
- 动效失败时页面仍必须可用。
|
|
47
|
-
|
|
48
|
-
## 4. 响应式规则
|
|
49
|
-
|
|
50
|
-
每个用户可见页面都必须写清楚 desktop / tablet / mobile 的布局策略。
|
|
51
|
-
|
|
52
|
-
| 视口 | 必须说明 | 常见策略 |
|
|
53
|
-
| --- | --- | --- |
|
|
54
|
-
| Desktop >= 1200px | 主内容宽度、侧栏、表格列、操作区位置 | 横向筛选条 + 数据表 + 分页 |
|
|
55
|
-
| Tablet 768-1199px | 筛选换行、列显隐、操作折叠 | 筛选条换行,次要列隐藏 |
|
|
56
|
-
| Mobile < 768px | 筛选入口、表格替代形态、底部操作、触控尺寸 | 筛选抽屉,表格转卡片,分页简化 |
|
|
57
|
-
|
|
58
|
-
移动端禁止只依赖横向滚动完成主要流程。若表格必须横向滚动,必须说明原因、最小宽度、冻结列或摘要卡片替代方案。
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
-
|
|
63
|
-
-
|
|
64
|
-
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
-
|
|
71
|
-
-
|
|
72
|
-
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
-
|
|
80
|
-
-
|
|
81
|
-
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
-
|
|
124
|
-
-
|
|
125
|
-
-
|
|
126
|
-
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
-
|
|
135
|
-
-
|
|
136
|
-
-
|
|
137
|
-
|
|
138
|
-
|
|
1
|
+
# Frontend Quality Rules
|
|
2
|
+
|
|
3
|
+
本文件定义前端页面从“能用”到“可交付”的最低质量尺子。它服务于 `spec-to-ui-to-code-workflow.md`、`design-brief.md`、`image-to-frontend-spec.md`、`component-map.md`、`screen-states.md` 和 `visual-parity-review.md`,不替代项目自己的品牌规范或产品需求。
|
|
4
|
+
|
|
5
|
+
## 1. 质量分级
|
|
6
|
+
|
|
7
|
+
| 等级 | 定义 | 必备证据 | 不能声称 |
|
|
8
|
+
| --- | --- | --- | --- |
|
|
9
|
+
| P0 可用 | 主路径能完成,关键控件可操作 | 主路径 story 或 E2E,基本截图 | 生产级体验 |
|
|
10
|
+
| P1 完整 | default / loading / empty / error / permission / long content / mobile 有规格和验证 | 状态矩阵、story 覆盖、移动端截图 | 视觉精修完成 |
|
|
11
|
+
| P2 精修 | 视觉层级、响应式、动效、可访问性和文案有明确标准并通过评审 | visual parity、a11y smoke、responsive matrix | 可无限复用 |
|
|
12
|
+
| P3 生产级 | 架构可维护,组件边界清晰,性能预算和回归证据完整 | frontend architecture、performance budget、regression evidence | 无需后续治理 |
|
|
13
|
+
|
|
14
|
+
`feature_impl` 的前端任务如果没有写明目标等级,默认按 P1 验收;用户可见核心流程默认至少 P2。
|
|
15
|
+
|
|
16
|
+
## 2. 审美反模式
|
|
17
|
+
|
|
18
|
+
以下情况出现任意一项,Stage 1 或视觉评审应要求返工,除非 Design Brief 明确说明原因:
|
|
19
|
+
|
|
20
|
+
- 页面只由大块卡片堆叠组成,缺少信息层级。
|
|
21
|
+
- 全页面灰白无重点,主要操作、危险操作和状态反馈不可区分。
|
|
22
|
+
- 使用无意义渐变、装饰图形或营销式 hero 来包装操作型后台页面。
|
|
23
|
+
- 所有按钮、标签、状态、表格行的视觉权重相同。
|
|
24
|
+
- 表格密度失控:行高、列宽、数字、标签和操作区没有扫描节奏。
|
|
25
|
+
- 移动端只做横向滚动,没有重排、折叠或卡片化策略。
|
|
26
|
+
- loading / empty / error 只是一行临时文案,没有恢复路径。
|
|
27
|
+
- 图标、颜色或动画只起装饰作用,不能帮助识别状态或操作。
|
|
28
|
+
|
|
29
|
+
## 3. 动效规则
|
|
30
|
+
|
|
31
|
+
动效必须解释状态变化,不承担主要信息表达。
|
|
32
|
+
|
|
33
|
+
| 场景 | 推荐动效 | 时长 | 约束 |
|
|
34
|
+
| --- | --- | --- | --- |
|
|
35
|
+
| 弹窗 / 抽屉打开 | opacity + scale 或 translate | 120-180ms | 必须有焦点管理 |
|
|
36
|
+
| 筛选 chip 增删 | opacity + slight translate | 100-160ms | 不得推动整页大范围跳动 |
|
|
37
|
+
| 表格刷新 | skeleton / row fade | 120-220ms | 高频刷新时禁用行级动画 |
|
|
38
|
+
| 空态 / 错误态切换 | opacity | 120-180ms | 文案和恢复操作优先 |
|
|
39
|
+
| 保存成功 / dirty 清除 | button state + inline status | 120-180ms | 不得只依赖 toast |
|
|
40
|
+
|
|
41
|
+
硬约束:
|
|
42
|
+
|
|
43
|
+
- 首选 `transform` 和 `opacity`,不得用会持续触发布局的动画属性。
|
|
44
|
+
- 必须支持 `prefers-reduced-motion` 或等价 reduced motion 开关。
|
|
45
|
+
- 动效不能隐藏错误、禁用、权限不足或保存失败。
|
|
46
|
+
- 动效失败时页面仍必须可用。
|
|
47
|
+
|
|
48
|
+
## 4. 响应式规则
|
|
49
|
+
|
|
50
|
+
每个用户可见页面都必须写清楚 desktop / tablet / mobile 的布局策略。
|
|
51
|
+
|
|
52
|
+
| 视口 | 必须说明 | 常见策略 |
|
|
53
|
+
| --- | --- | --- |
|
|
54
|
+
| Desktop >= 1200px | 主内容宽度、侧栏、表格列、操作区位置 | 横向筛选条 + 数据表 + 分页 |
|
|
55
|
+
| Tablet 768-1199px | 筛选换行、列显隐、操作折叠 | 筛选条换行,次要列隐藏 |
|
|
56
|
+
| Mobile < 768px | 筛选入口、表格替代形态、底部操作、触控尺寸 | 筛选抽屉,表格转卡片,分页简化 |
|
|
57
|
+
|
|
58
|
+
移动端禁止只依赖横向滚动完成主要流程。若表格必须横向滚动,必须说明原因、最小宽度、冻结列或摘要卡片替代方案。
|
|
59
|
+
|
|
60
|
+
移动端和嵌入式 WebView 额外约束:
|
|
61
|
+
|
|
62
|
+
- 必须说明 iOS 刘海屏、灵动岛、底部 Home Indicator、Android 状态栏 / 导航栏的安全区策略。
|
|
63
|
+
- 键盘弹起后,输入框、提交按钮和错误提示不得被遮挡。
|
|
64
|
+
- 横竖屏切换后,主流程不能丢失状态或出现不可操作区域。
|
|
65
|
+
|
|
66
|
+
## 5. 组件复用边界
|
|
67
|
+
|
|
68
|
+
- `ui primitives`: 只放按钮、输入、弹窗、菜单、表格基础结构等无业务语义组件。
|
|
69
|
+
- `data-table`: 只放排序、筛选、分页、列显隐、空态容器等表格通用行为。
|
|
70
|
+
- `features/<domain>`: 放业务组件、业务 hooks、字段映射、权限逻辑和页面组合。
|
|
71
|
+
- `api-client`: 放契约生成或手写 API 调用,不直接依赖 UI。
|
|
72
|
+
- `model/schema`: 放类型、枚举、表单校验和 URL query 解析。
|
|
73
|
+
|
|
74
|
+
复用准入:
|
|
75
|
+
|
|
76
|
+
- 新通用组件必须至少有两个明确使用场景,或是基础 primitive。
|
|
77
|
+
- 业务语义不稳定时留在 feature 内,不提前抽到 `packages/ui`。
|
|
78
|
+
- 通用组件必须有 props 契约、状态矩阵、story 和可访问性说明。
|
|
79
|
+
- generated types 可以作为数据输入类型,不能决定 UI primitive 的命名和职责。
|
|
80
|
+
- 修改 existing 公共组件时,必须列出受影响调用方、兼容策略和回归测试;不能为了一个页面直接改坏全局行为。
|
|
81
|
+
- 优先通过 wrapper、variant、slot、可选 props 扩展现有组件,不直接破坏旧 props 契约。
|
|
82
|
+
|
|
83
|
+
## 6. 交互与文案规则
|
|
84
|
+
|
|
85
|
+
每个关键操作必须定义:
|
|
86
|
+
|
|
87
|
+
- 触发条件、禁用条件、加载反馈、成功反馈、失败反馈。
|
|
88
|
+
- inline error、toast、modal confirm 的使用边界。
|
|
89
|
+
- dirty 状态如何产生、如何保存、何时清除。
|
|
90
|
+
- 重试、取消、关闭、返回是否保留用户输入。
|
|
91
|
+
- 空态文案、错误文案、权限文案、按钮文案和长文本截断规则。
|
|
92
|
+
|
|
93
|
+
表单体验至少补充:
|
|
94
|
+
|
|
95
|
+
- 校验触发时机:blur / submit / input
|
|
96
|
+
- 错误字段聚焦策略
|
|
97
|
+
- submitting 与 disabled 的区分
|
|
98
|
+
- 防重复提交策略
|
|
99
|
+
- 输入格式与键盘类型策略
|
|
100
|
+
- 成功 / 失败后的恢复或保留输入策略
|
|
101
|
+
|
|
102
|
+
空态必须区分“系统没有数据”和“筛选后没有结果”。错误态必须包含用户可执行的恢复路径。
|
|
103
|
+
|
|
104
|
+
状态不是给评审看的页面说明。`loading / empty / error / disabled / permission / mobile` 等状态必须由真实状态源驱动,例如 API 请求状态、权限结果、空数据集合、表单 dirty/valid 状态、路由或 query 参数、feature flag、响应式断点、story controls 或可控 mock。页面可以有用户可见文案,但不能出现“这里是 loading 状态”“权限态展示如下”等占位说明来冒充实现。
|
|
105
|
+
|
|
106
|
+
每个 P0/P1 状态都必须能在代码和证据中追溯到:
|
|
107
|
+
|
|
108
|
+
- 状态源:store、query、hook、props、fixture、mock response、viewport 或权限判断。
|
|
109
|
+
- 渲染分支:组件条件分支、状态组件、disabled 属性、error boundary、empty renderer 或 responsive layout。
|
|
110
|
+
- 触发路径:用户操作、API 响应、测试 seed、story control、query 参数、mock scenario 或 viewport。
|
|
111
|
+
- 复验证据:story、interaction test、E2E 步骤、截图矩阵或 visual parity finding。
|
|
112
|
+
|
|
113
|
+
除 `loading / empty / error / disabled / permission / mobile` 外,如场景存在,还应显式覆盖:
|
|
114
|
+
|
|
115
|
+
- `submitting`
|
|
116
|
+
- `retry`
|
|
117
|
+
- `offline`
|
|
118
|
+
|
|
119
|
+
## 7. 可访问性规则
|
|
120
|
+
|
|
121
|
+
前端规格至少覆盖:
|
|
122
|
+
|
|
123
|
+
- 键盘路径和焦点顺序。
|
|
124
|
+
- 弹窗、抽屉、菜单的 focus trap 和关闭方式。
|
|
125
|
+
- 表单错误与输入控件的关联。
|
|
126
|
+
- 加载、保存成功、失败的屏幕阅读器提示。
|
|
127
|
+
- 色彩不能作为唯一信息来源。
|
|
128
|
+
- 移动端触控目标不小于 44x44px,除非平台规范另有说明。
|
|
129
|
+
|
|
130
|
+
## 8. 性能预算
|
|
131
|
+
|
|
132
|
+
前端设计阶段必须说明是否存在以下风险:
|
|
133
|
+
|
|
134
|
+
- 首屏依赖过多组件、图标、图表或动画库。
|
|
135
|
+
- 表格超过 100 行、复杂筛选、虚拟滚动或服务端分页需求。
|
|
136
|
+
- 图片、头像、缩略图或远程媒体影响布局稳定。
|
|
137
|
+
- 动效或重排可能影响滚动和输入响应。
|
|
138
|
+
|
|
139
|
+
如果页面包含复杂表格、图表或列表,必须在 `frontend-architecture.md` 或 DEV-PLAN 中写明 client/server 分界和性能验证方式。
|
|
140
|
+
|
|
141
|
+
## 9. 证据要求
|
|
142
|
+
|
|
143
|
+
前端任务完成声明至少包含:
|
|
144
|
+
|
|
145
|
+
- story / interaction / E2E 中的对应状态覆盖。
|
|
146
|
+
- desktop 和 mobile 的真实浏览器截图。
|
|
147
|
+
- visual parity 结论。
|
|
148
|
+
- 可访问性 smoke 结论或明确豁免。
|
|
149
|
+
- 性能风险检查结论;复杂页面需附性能预算验证。
|
|
150
|
+
|
|
151
|
+
## 10. State Surface Gate
|
|
152
|
+
|
|
153
|
+
前端任务进入实现前,必须把状态暴露方式写进 plan 或当前 task 的 `state_surface`。可接受的状态表面包括:
|
|
154
|
+
|
|
155
|
+
- Storybook / story 文件:适合组件、页面片段、状态矩阵和视觉回归。
|
|
156
|
+
- 真实 route + query / fixture:适合页面级状态、权限态和深链路复现。
|
|
157
|
+
- Mock scenario / MSW / API fixture:适合 loading、empty、error、权限和异常返回。
|
|
158
|
+
- E2E seed / test data:适合跨页面流程、保存、删除、批量操作和副作用验证。
|
|
159
|
+
- Viewport matrix:适合响应式、移动端重排和触控行为。
|
|
160
|
+
|
|
161
|
+
每个 P0/P1 状态至少要有一个可运行入口,并写明评审看哪里、回归跑什么、失败证据放哪里。状态只存在于设计稿、截图或聊天说明中时,Stage 1 应要求补状态表面,而不是让实现任务继续猜。
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# 回归规则
|
|
2
|
+
|
|
3
|
+
| 风险 | 约束 |
|
|
4
|
+
| --- | --- |
|
|
5
|
+
| 误改文件 | Git 工作区清洁检查、task 边界、owned paths |
|
|
6
|
+
| 漏测 | 每个任务必须运行 `test_command` |
|
|
7
|
+
| 伪完成 | `passes=true` 必须建立在 fresh evidence 上 |
|
|
8
|
+
| 文档漂移 | 规则、模板、命令改动后同步更新对应文档 |
|
|
9
|
+
|
|
10
|
+
## 基本要求
|
|
11
|
+
|
|
12
|
+
- 文档改动至少运行 `git diff --check`。
|
|
13
|
+
- 代码改动必须运行与任务风险匹配的验证命令。
|
|
14
|
+
- 不允许在未验证的情况下手工把任务标记为通过。
|
|
15
|
+
|
|
16
|
+
## 需求到验证的左移规则
|
|
17
|
+
|
|
18
|
+
- 测试从需求收敛阶段开始介入,不允许等代码完成后才第一次补测试范围。
|
|
19
|
+
- 任何 P0/P1 需求进入实现前,至少要有 Requirement ID、业务规则、正向示例、异常示例、测试层级映射、测试数据说明和证据路径。
|
|
20
|
+
- 任何 P0/P1 或高风险测试进入脚本实现前,必须先定义测试意图和 Oracle;写操作、权限、状态机、异步链路必须包含副作用或无副作用验证。
|
|
21
|
+
- 创建或重建 `task.json` 时必须一次性补齐完整 QA 合约;后续不得依赖人工逐项补 `requirement_ids`、测试数据、Oracle、开发验证、最终验收验证、证据路径或整链路验证。
|
|
22
|
+
- `docs/testing/TRACEABILITY_MATRIX.md`、验收示例和验证矩阵属于实现前 truth source;缺失时应优先补齐,而不是继续猜测实现。
|
|
23
|
+
- 修改业务代码时必须同时检查测试影响;相关测试缺失时,先补测试骨架或测试计划,再继续实现。
|
|
24
|
+
- Stage 2 必须拦截假测试,包括只断言 200 / truthy、只测 happy path、mock 被测逻辑、缺少业务断言、缺少执行证据或缺少来源绑定的测试。
|
|
25
|
+
|
|
26
|
+
## 完成定义
|
|
27
|
+
|
|
28
|
+
- 对外部系统、既定开源栈、第三方平台或真实环境的集成型需求,完成定义至少包含:真实依赖接上、真实请求走通、成功态证据、失败态证据。
|
|
29
|
+
- 页面能打开、本地接口能返回、单元测试通过,都不足以声称正式 `FR-*` 已完成。
|
|
30
|
+
- 每个 `feature_impl` 必须同时具备两段证据:编码过程中的 `development_validation`,以及代码写完后从用户 / 业务闭环视角重新运行的 `acceptance_validation`。
|
|
31
|
+
- 每个 `feature_impl` 至少需要故事级完整链路验收证据;只跑单元测试、局部 smoke、affected tests、静态检查或 `git diff --check` 不足以完成任务。
|
|
32
|
+
- 如果当前只是原型 / spike / exploratory 路径,不要把演示性交付直接标成正式 `FR-*` 完成;应改用 `PROTO-*`、`SPIKE-*`、`INTEGRATION-*` 等单独标识,或在 spec / plan 中显式记录该 FR 仍处于未完成集成态。
|
|
33
|
+
- 单元测试只能证明本地逻辑;集成型需求还必须补环境 smoke、E2E、真实下游连通性验证和验收证据 note。
|
|
34
|
+
- Release 完成必须有发布候选级跨故事整链路、P0/P1 回归、契约/API、E2E/视觉或等价系统级验证;不得把各子任务局部测试简单相加当作整测。
|
|
35
|
+
- Stage 17 只负责 fresh evidence、affected tests 和 P0/P1 回归确认,不负责第一次定义需求测试范围。
|
|
36
|
+
- 重构任务必须显式声明行为不变约束;接口、用户路径、数据结构和兼容逻辑不能在未说明时被顺手改变。
|
|
37
|
+
- 重构结束前应按声明范围清理无用变量、无用函数、无用组件、无用类型、无用 import、临时代码和过期注释。
|
|
38
|
+
|
|
39
|
+
## 技术栈验证基线
|
|
40
|
+
|
|
41
|
+
| 改动类型 | 最小验证 |
|
|
42
|
+
| --- | --- |
|
|
43
|
+
| 文档 | `git diff --check` |
|
|
44
|
+
| JSON | `ConvertFrom-Json` |
|
|
45
|
+
| PowerShell | Parser 语法检查 |
|
|
46
|
+
| TypeScript / 前端 | lint、typecheck、build |
|
|
47
|
+
| API 或业务流程 | 单元测试、集成测试或 E2E,按风险选择 |
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# Trace Format 模板
|
|
2
|
+
|
|
3
|
+
## 1. 文件命名
|
|
4
|
+
|
|
5
|
+
```text
|
|
6
|
+
traces/<task-id>-<yyyyMMdd-HHmmss>.json
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## 2. 必需字段
|
|
10
|
+
|
|
11
|
+
| 字段 | 类型 | 说明 |
|
|
12
|
+
| --- | --- | --- |
|
|
13
|
+
| `task_id` | string | 当前任务 id |
|
|
14
|
+
| `agent` | string | 执行代理,如 `codex` |
|
|
15
|
+
| `started_at` | string | ISO 8601 开始时间 |
|
|
16
|
+
| `ended_at` | string | ISO 8601 结束时间 |
|
|
17
|
+
| `status` | enum | `passed`、`failed`、`blocked` |
|
|
18
|
+
| `commands` | array | 执行命令和退出码 |
|
|
19
|
+
| `stage1_review` | object | Stage 1 审查 verdict、退出码和摘要 |
|
|
20
|
+
| `stage2_review` | object | Stage 2 审查 verdict、退出码和摘要 |
|
|
21
|
+
|
|
22
|
+
## 3. 推荐字段
|
|
23
|
+
|
|
24
|
+
| 字段 | 类型 | 说明 |
|
|
25
|
+
| --- | --- | --- |
|
|
26
|
+
| `task_session_id` | string | 当前 task 的 fresh session id |
|
|
27
|
+
| `task_kind` | string | 任务类型,例如 `harness`、`smoke`、`feature_impl` |
|
|
28
|
+
| `gate_profile` | string | 本任务启用的 gate 强度 |
|
|
29
|
+
| `schema_version` | string | trace schema 版本 |
|
|
30
|
+
| `session_dir` | string | 当前 task session 的持久日志目录 |
|
|
31
|
+
| `events_file` | string/null | implementation 阶段主 Codex JSONL 事件流文件;review JSONL 如有保留,仍记录在 `log_files` / `logs` |
|
|
32
|
+
| `log_files` | array | implementation / review / test output 等日志文件路径 |
|
|
33
|
+
| `evidence_files` | array | 与当前任务关联的额外证据附件 |
|
|
34
|
+
| `role` | string | 当前 Agent 的角色,例如 `frontend`、`backend`、`reviewer` |
|
|
35
|
+
| `model` | string | 实际使用的模型 |
|
|
36
|
+
| `reasoning_effort` | enum | 实际使用的思考深度: `none`、`low`、`medium`、`high`、`xhigh` |
|
|
37
|
+
| `model_policy` | object | 模型策略来源,例如 policy 文件和 role 覆盖路径 |
|
|
38
|
+
| `required_truth_sources` | array | 本任务必须满足的 truth source 类型 |
|
|
39
|
+
| `files_changed` | array | Git 检测到的文件 |
|
|
40
|
+
| `blocked_reason` | string/null | 阻塞原因 |
|
|
41
|
+
| `final_message` | string | Codex 最终消息摘要 |
|
|
42
|
+
| `test_command` | string | 当前任务验证命令 |
|
|
43
|
+
| `qa_evidence` | object/null | 测试用例、Oracle、证据文件、副作用断言、假测试检测和失败复现摘要 |
|
|
44
|
+
| `failed_stage` | string/null | 失败发生在哪个 gate |
|
|
45
|
+
| `unexpected_paths` | array | commit path ownership gate 阻断时记录超出 `owned_paths` / runtime allowlist 的路径 |
|
|
46
|
+
| `review_context` | object | Stage 1 / Stage 2 对照的真相源文件集合 |
|
|
47
|
+
| `truth_source_state` | array | truth source 满足情况、已找到路径和缺失项 |
|
|
48
|
+
| `knowledge_references` | array | 当前任务读取并实际使用的知识条目 |
|
|
49
|
+
| `knowledge_outputs` | array | 当前任务新增、更新或建议归档的知识条目 |
|
|
50
|
+
| `archive_summary` | object/null | 归档阶段对知识引用、知识产出和成熟度变化的摘要 |
|
|
51
|
+
| `logs` | object | implementation / stage review / test output 的日志文件路径 |
|
|
52
|
+
|
|
53
|
+
## 3.1 `qa_evidence` 推荐结构
|
|
54
|
+
|
|
55
|
+
```json
|
|
56
|
+
{
|
|
57
|
+
"case_ids": ["TC-ORDER-CANCEL-007"],
|
|
58
|
+
"requirement_ids": ["REQ-ORDER-003"],
|
|
59
|
+
"oracles": ["response", "database", "event", "audit", "no_side_effect"],
|
|
60
|
+
"evidence_files": ["artifacts/tests/order-cancel-007.json"],
|
|
61
|
+
"side_effect_checks": ["db_snapshot_before_after", "event_not_emitted"],
|
|
62
|
+
"anti_fake_checks": {
|
|
63
|
+
"has_semantic_assertion": true,
|
|
64
|
+
"verifies_side_effect": true,
|
|
65
|
+
"source_bound": true,
|
|
66
|
+
"target_path_proven": true
|
|
67
|
+
},
|
|
68
|
+
"failure_repro": null
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## 4. 校验
|
|
73
|
+
|
|
74
|
+
使用 `docs/harness/trace.schema.json` 校验 trace。CI 中可以用任意 JSON Schema validator 执行。
|
|
75
|
+
|
|
76
|
+
## 5. 可观测性最低要求
|
|
77
|
+
|
|
78
|
+
如果任务涉及 API、异步链路、外部系统、权限、支付、删除、上传或关键业务闭环,相关证据中至少应能回答:
|
|
79
|
+
|
|
80
|
+
- 请求 ID 是什么
|
|
81
|
+
- 用户 ID / actor 是什么
|
|
82
|
+
- 接口路径或业务入口是什么
|
|
83
|
+
- 失败原因是什么
|
|
84
|
+
- 耗时是多少
|
|
85
|
+
- 是否存在审计记录
|
|
86
|
+
- 是否有对应告警或失败通知
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# AGENTS.md
|
|
2
|
+
|
|
3
|
+
## 目录作用
|
|
4
|
+
|
|
5
|
+
- 存放产品素材模板文档的镜像副本。
|
|
6
|
+
|
|
7
|
+
## 结构索引
|
|
8
|
+
|
|
9
|
+
- `prd-lite.md`、`acceptance-criteria.md`、`page-inventory.md`、`difficulty-research.md` 等产品模板镜像。
|
|
10
|
+
|
|
11
|
+
## 修改规则
|
|
12
|
+
|
|
13
|
+
- 上游 canonical 在 `docs/codex-harness-engineering/templates/product/*`。
|
|
14
|
+
- 当前默认安装主线如果仍以 `spec/*` 为主,这里更应视为上游素材镜像。
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
# PRD-Lite 模板
|
|
2
|
+
|
|
3
|
+
> 目标: 把原始需求收敛成 Codex 可以直接消费的产品真相源。未填完整前,不应进入设计或实现阶段。
|
|
4
|
+
|
|
5
|
+
## 1. 基本信息
|
|
6
|
+
|
|
7
|
+
- Feature ID:
|
|
8
|
+
- Feature 名称:
|
|
9
|
+
- 来源: issue / 会议纪要 / 事故复盘 / 业务需求 / 其他
|
|
10
|
+
- 负责人:
|
|
11
|
+
- 相关方:
|
|
12
|
+
- 当前状态: Draft / Review / Approved / Changed
|
|
13
|
+
- 最后更新:
|
|
14
|
+
|
|
15
|
+
## 2. 背景与问题
|
|
16
|
+
|
|
17
|
+
- 业务背景:
|
|
18
|
+
- 当前问题:
|
|
19
|
+
- 为什么现在做:
|
|
20
|
+
- 不做的影响:
|
|
21
|
+
- 现有替代方案:
|
|
22
|
+
|
|
23
|
+
## 3. 目标与非目标
|
|
24
|
+
|
|
25
|
+
### 目标
|
|
26
|
+
|
|
27
|
+
| 目标 ID | 目标描述 | 衡量方式 | 优先级 |
|
|
28
|
+
| --- | --- | --- | --- |
|
|
29
|
+
| G-001 | | | P0 |
|
|
30
|
+
|
|
31
|
+
### 非目标
|
|
32
|
+
|
|
33
|
+
| 非目标 ID | 本期明确不做 | 原因 | 后续处理 |
|
|
34
|
+
| --- | --- | --- | --- |
|
|
35
|
+
| NG-001 | | | |
|
|
36
|
+
|
|
37
|
+
## 4. 用户与角色
|
|
38
|
+
|
|
39
|
+
| 角色 | 使用场景 | 核心诉求 | 权限差异 | 优先级 |
|
|
40
|
+
| --- | --- | --- | --- | --- |
|
|
41
|
+
| | | | | P0 |
|
|
42
|
+
|
|
43
|
+
## 5. 范围边界
|
|
44
|
+
|
|
45
|
+
| 范围 | 内容 |
|
|
46
|
+
| --- | --- |
|
|
47
|
+
| In scope | |
|
|
48
|
+
| Out of scope | |
|
|
49
|
+
| 允许变更 | |
|
|
50
|
+
| 禁止变更 | |
|
|
51
|
+
| 依赖前置条件 | |
|
|
52
|
+
|
|
53
|
+
## 6. 业务流程
|
|
54
|
+
|
|
55
|
+
### 主流程
|
|
56
|
+
|
|
57
|
+
```mermaid
|
|
58
|
+
flowchart TD
|
|
59
|
+
A[开始] --> B[核心步骤]
|
|
60
|
+
B --> C[完成]
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### 异常流程
|
|
64
|
+
|
|
65
|
+
| 场景 ID | 异常场景 | 触发条件 | 预期行为 | 兜底策略 |
|
|
66
|
+
| --- | --- | --- | --- | --- |
|
|
67
|
+
| E-001 | | | | |
|
|
68
|
+
|
|
69
|
+
## 7. 页面 / 流程 / 接口影响
|
|
70
|
+
|
|
71
|
+
| 类型 | 名称 | 影响说明 | 对应真相源 |
|
|
72
|
+
| --- | --- | --- | --- |
|
|
73
|
+
| 页面 | | | `page-inventory.md` |
|
|
74
|
+
| 状态 | | | `state-matrix.yaml` |
|
|
75
|
+
| 接口 | | | `contracts/openapi.yaml` |
|
|
76
|
+
| 权限 | | | 本文权限矩阵 |
|
|
77
|
+
|
|
78
|
+
## 8. 功能需求
|
|
79
|
+
|
|
80
|
+
| 需求 ID | 用户故事 / 能力 | 优先级 | 关联页面 | 关联状态 | 验收入口 |
|
|
81
|
+
| --- | --- | --- | --- | --- | --- |
|
|
82
|
+
| FR-001 | As a [角色], I want [能力], so that [价值] | P0 | | | `acceptance-criteria.md` |
|
|
83
|
+
|
|
84
|
+
## 9. 需求到界面追溯
|
|
85
|
+
|
|
86
|
+
| 需求 ID | 关联页面 / 视图 | 页面状态 | UI 元素 / 操作 | 依赖字段 | 依赖接口 | 验收标准 | 追溯状态 |
|
|
87
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
88
|
+
| FR-001 | page-001 | default / empty / loading / error | | | | AC-001 | Pending |
|
|
89
|
+
|
|
90
|
+
> 完整追溯矩阵维护在 `docs/product/requirement-interface-matrix.md`。所有 P0/P1 需求必须完成映射。
|
|
91
|
+
|
|
92
|
+
## 10. 前置难点研究
|
|
93
|
+
|
|
94
|
+
| 难点 ID | 难点 / 不确定点 | 关联需求 | 影响界面 / 接口 | 风险等级 | 研究结论 | 状态 |
|
|
95
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
96
|
+
| DR-001 | | FR-001 | page-001 / API | High / Medium / Low | | Open |
|
|
97
|
+
|
|
98
|
+
> 详细研究记录维护在 `docs/product/difficulty-research.md`。高风险难点未关闭前,不进入实现阶段。
|
|
99
|
+
|
|
100
|
+
## 11. 业务规则
|
|
101
|
+
|
|
102
|
+
| 规则 ID | 规则描述 | 触发时机 | 校验逻辑 | 不满足时行为 |
|
|
103
|
+
| --- | --- | --- | --- | --- |
|
|
104
|
+
| BR-001 | | | | |
|
|
105
|
+
|
|
106
|
+
至少覆盖:
|
|
107
|
+
|
|
108
|
+
- 状态流转规则
|
|
109
|
+
- 权限拒绝规则
|
|
110
|
+
- 幂等 / 重复提交规则
|
|
111
|
+
- 外部依赖失败或超时后的兜底规则
|
|
112
|
+
- 对金额、库存、次数、唯一性等关键不变量的保护规则
|
|
113
|
+
|
|
114
|
+
## 12. 权限矩阵
|
|
115
|
+
|
|
116
|
+
| 操作 | 角色 A | 角色 B | 角色 C | 备注 |
|
|
117
|
+
| --- | --- | --- | --- | --- |
|
|
118
|
+
| 查看 | 允许 | 只读 | 禁止 | |
|
|
119
|
+
|
|
120
|
+
## 13. 数据与字段
|
|
121
|
+
|
|
122
|
+
| 字段 | 中文名 | 类型 | 来源 | 必填 | 取值范围 / 枚举 | 边界规则 |
|
|
123
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
124
|
+
| | | | | | | |
|
|
125
|
+
|
|
126
|
+
## 14. 非功能需求
|
|
127
|
+
|
|
128
|
+
| 类型 | 要求 | 指标 / 标准 | 优先级 | 验证方式 |
|
|
129
|
+
| --- | --- | --- | --- | --- |
|
|
130
|
+
| 性能 | | | P0 | |
|
|
131
|
+
| 安全 | | | P0 | |
|
|
132
|
+
| 可用性 | | | P1 | |
|
|
133
|
+
| 可访问性 | | | P1 | |
|
|
134
|
+
| 兼容性 | | | P1 | |
|
|
135
|
+
|
|
136
|
+
## 15. 成功标准
|
|
137
|
+
|
|
138
|
+
| 指标 ID | 成功标准 | 目标值 | 衡量方式 |
|
|
139
|
+
| --- | --- | --- | --- |
|
|
140
|
+
| SC-001 | | | |
|
|
141
|
+
|
|
142
|
+
## 16. 风险、假设与待确认
|
|
143
|
+
|
|
144
|
+
### 风险
|
|
145
|
+
|
|
146
|
+
| 风险 ID | 风险描述 | 影响 | 概率 | 缓解措施 | 负责人 |
|
|
147
|
+
| --- | --- | --- | --- | --- | --- |
|
|
148
|
+
| R-001 | | 高/中/低 | 高/中/低 | | |
|
|
149
|
+
|
|
150
|
+
### 假设
|
|
151
|
+
|
|
152
|
+
| 假设 ID | 假设内容 | 验证方式 | 失效影响 |
|
|
153
|
+
| --- | --- | --- | --- |
|
|
154
|
+
| A-001 | | | |
|
|
155
|
+
|
|
156
|
+
### 待确认
|
|
157
|
+
|
|
158
|
+
| 问题 ID | 问题 | 相关方 | 截止日期 | 状态 |
|
|
159
|
+
| --- | --- | --- | --- | --- |
|
|
160
|
+
| Q-001 | | | | 待确认 |
|
|
161
|
+
|
|
162
|
+
## 17. 变更记录
|
|
163
|
+
|
|
164
|
+
| 版本 | 日期 | 变更内容 | 影响范围 | 评审人 |
|
|
165
|
+
| --- | --- | --- | --- | --- |
|
|
166
|
+
| v0.1 | | 初稿 | | |
|