@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
package/package-source/docs/codex-harness-engineering/templates/docs/prompt-knowledge-integration.md
CHANGED
|
@@ -1,89 +1,100 @@
|
|
|
1
|
-
# Prompt Knowledge Integration
|
|
2
|
-
|
|
3
|
-
本文定义 `.codex/prompts/*` 如何消费 `docs/harness/*` 和 `docs/knowledge/*`,确保知识沉淀不只停留在文档里,而是进入实现、审查、修复和归档链路。
|
|
4
|
-
|
|
5
|
-
## 目标
|
|
6
|
-
|
|
7
|
-
- 每个执行角色都知道何时读取知识目录。
|
|
8
|
-
- 每个输出角色都能记录 `knowledge_references` 和 `knowledge_outputs`。
|
|
9
|
-
- review 能检查知识是否被使用、是否被误用。
|
|
10
|
-
- failure triage、repair 和 visual review 能把坏例转成可归档建议。
|
|
11
|
-
- harness writer 和 docs worker 能按规则治理协议决定内容写到哪里。
|
|
12
|
-
|
|
13
|
-
##
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
|
27
|
-
|
|
|
28
|
-
| `
|
|
29
|
-
| `
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
|
36
|
-
|
|
|
37
|
-
| `
|
|
38
|
-
| `
|
|
39
|
-
| `
|
|
40
|
-
| `
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
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
|
-
|
|
1
|
+
# Prompt Knowledge Integration
|
|
2
|
+
|
|
3
|
+
本文定义 `.codex/prompts/*` 如何消费 `docs/harness/*` 和 `docs/knowledge/*`,确保知识沉淀不只停留在文档里,而是进入实现、审查、修复和归档链路。
|
|
4
|
+
|
|
5
|
+
## 目标
|
|
6
|
+
|
|
7
|
+
- 每个执行角色都知道何时读取知识目录。
|
|
8
|
+
- 每个输出角色都能记录 `knowledge_references` 和 `knowledge_outputs`。
|
|
9
|
+
- review 能检查知识是否被使用、是否被误用。
|
|
10
|
+
- failure triage、repair 和 visual review 能把坏例转成可归档建议。
|
|
11
|
+
- harness writer 和 docs worker 能按规则治理协议决定内容写到哪里。
|
|
12
|
+
|
|
13
|
+
## 默认读取顺序
|
|
14
|
+
|
|
15
|
+
1. `AGENTS.md`
|
|
16
|
+
2. `docs/ai/repo-map.md`
|
|
17
|
+
3. `docs/ai/architecture-brief.md`
|
|
18
|
+
4. `docs/ai/CURRENT_TASK.md`
|
|
19
|
+
5. 任务需要时读取 `docs/ai/PROJECT_CONTEXT.md`、`DECISIONS.md`、`API_MAP.md`、`DB_SCHEMA.md`、`KNOWN_ISSUES.md`
|
|
20
|
+
6. `docs/harness/*`
|
|
21
|
+
7. `docs/knowledge/knowledge-catalog.md`
|
|
22
|
+
8. 仅在项目内信息不足或问题依赖 freshness 时查询 MCP / 外部知识
|
|
23
|
+
|
|
24
|
+
## Prompt 覆盖矩阵
|
|
25
|
+
|
|
26
|
+
| Prompt | 知识消费 | 知识产出 |
|
|
27
|
+
| --- | --- | --- |
|
|
28
|
+
| `controller-loop.md` | 判断任务是否需要注入 `docs/knowledge/` 和规则治理上下文 | 决定是否进入 `ARCHIVE-*` |
|
|
29
|
+
| `implement-one-task.md` | 按阶段读取 knowledge catalog 和相关条目 | 输出 `Knowledge References` / `Knowledge Outputs` |
|
|
30
|
+
| `review-stage1-spec.md` | 检查 `knowledge` truth source、archive 阶段和规则误升级 | 输出 `knowledge_gap` finding |
|
|
31
|
+
| `review-stage2-quality.md` | 检查代码或文档决策是否引用知识 | 输出 `knowledge_gap` finding |
|
|
32
|
+
| `failure-triage.md` | 读取历史坑辅助归因 | 输出 `knowledgeOutputSuggestions` |
|
|
33
|
+
| `repair-one-finding.md` | 读取相关知识,避免重复踩坑 | 输出修复后的知识建议 |
|
|
34
|
+
| `visual-evaluator.md` | 使用设计和视觉相关经验 | 输出视觉 pitfall / guideline 建议 |
|
|
35
|
+
| `harness-audit.md` | 审计 prompt、trace、archive 和 catalog 覆盖 | 输出 Knowledge Gaps |
|
|
36
|
+
| `worker-role/harness-writer.md` | 读取知识架构和规则治理 | 同步 prompt/docs/knowledge mirrors |
|
|
37
|
+
| `worker-role/docs-worker.md` | 判断长期文档与临时讨论边界 | 把可复用经验写入 `docs/knowledge/` |
|
|
38
|
+
| `worker-role/frontend-worker.md` | 读取 UI/视觉/组件经验 | 输出前端知识引用和新坑建议 |
|
|
39
|
+
| `worker-role/backend-worker.md` | 读取架构、安全、API 风险经验 | 输出后端知识引用和新坑建议 |
|
|
40
|
+
| `worker-role/test-runner.md` | 读取历史测试/环境坑 | 输出失败模式归档建议 |
|
|
41
|
+
|
|
42
|
+
## 阶段查询矩阵
|
|
43
|
+
|
|
44
|
+
实现会话不应一次性读取全部知识。先读 `knowledge-catalog.md`,再按阶段和任务类型选择 catalog 与少量完整条目。
|
|
45
|
+
|
|
46
|
+
| 阶段 | 查询重点 | 优先知识类型 | 默认用途 |
|
|
47
|
+
| --- | --- | --- | --- |
|
|
48
|
+
| `analysis` / 产品分析 | 业务实体、历史需求、流程和已知坑 | `model`、`process`、`pitfall` | 补齐需求边界、异常流和术语 |
|
|
49
|
+
| `plan` / 技术分析 | 既有架构决策、禁止做法、失败模式 | `decision`、`guideline(avoid)`、`pitfall` | 避免重复推导和重复踩坑 |
|
|
50
|
+
| `design` / 架构设计 | 实体关系、模块边界、历史决策 | `model`、`decision` | 保持设计与已有约束一致 |
|
|
51
|
+
| `implement` | 编码实践、团队约定、风险路径 | `guideline`、`pitfall` | 指导实现细节和边界处理 |
|
|
52
|
+
| `verify` / release | 回归风险、环境坑、禁止做法 | `pitfall`、`guideline(avoid)` | 选择 affected tests 和失败排查路径 |
|
|
53
|
+
| `archive` | 本轮引用、产出、冲突和可提升条目 | 全部类型 | 更新 `last_referenced`、输出 promotion/decay/conflict/merge candidates |
|
|
54
|
+
|
|
55
|
+
每个阶段只读取和当前任务直接相关的条目。`draft` 条目可以启发分析,但不能成为阻塞性 review 依据;`proven` 条目才适合升级为规则、模板或 prompt。
|
|
56
|
+
|
|
57
|
+
## 输出字段约定
|
|
58
|
+
|
|
59
|
+
实现、修复和 worker handoff 应尽量使用以下 Markdown 字段:
|
|
60
|
+
|
|
61
|
+
```markdown
|
|
62
|
+
## Knowledge References
|
|
63
|
+
- `id`: title - used_in - `path`
|
|
64
|
+
|
|
65
|
+
## Knowledge Outputs
|
|
66
|
+
- `suggested-id`: type - title - action - `target-path`
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
失败归因 JSON 使用:
|
|
70
|
+
|
|
71
|
+
```json
|
|
72
|
+
{
|
|
73
|
+
"knowledgeReferences": [],
|
|
74
|
+
"knowledgeOutputSuggestions": []
|
|
75
|
+
}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
driver trace 使用 `docs/harness/trace.schema.json` 中的:
|
|
79
|
+
|
|
80
|
+
- `knowledge_references`
|
|
81
|
+
- `knowledge_outputs`
|
|
82
|
+
- `archive_summary`
|
|
83
|
+
|
|
84
|
+
## 使用边界
|
|
85
|
+
|
|
86
|
+
- `draft` 知识只能作为参考,不应作为阻塞性 review 依据。
|
|
87
|
+
- `verified` 知识可以作为 reviewer 的辅助依据。
|
|
88
|
+
- `proven` 知识才适合升级为规则、模板或 prompt。
|
|
89
|
+
- 单次任务经验不得直接写入 `AGENTS.md`,应先进入 `docs/knowledge/`。
|
|
90
|
+
- prompt 改动后必须同步 `agent/.codex/prompts/`、`docs/codex-harness-engineering/templates/prompts/` 和 `.agents/docs/codex-harness-engineering/templates/prompts/`。
|
|
91
|
+
|
|
92
|
+
## 维护检查
|
|
93
|
+
|
|
94
|
+
每次改动 `docs/harness/knowledge-architecture.md`、`docs/harness/rule-governance.md`、`docs/harness/trace.schema.json` 或 `tools/harness/templates/project-task-template.json` 后,检查:
|
|
95
|
+
|
|
96
|
+
1. `implement-one-task.md` 是否仍要求输出知识引用和知识产出。
|
|
97
|
+
2. Stage 1 / Stage 2 review 是否能检查知识缺口。
|
|
98
|
+
3. failure / repair / visual prompts 是否能把坏例转成归档建议。
|
|
99
|
+
4. worker-role prompts 是否要求读取对应知识文档。
|
|
100
|
+
5. `refresh-agent-package.ps1 -CheckOnly` 是否通过。
|
|
@@ -1,45 +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
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
|
42
|
-
|
|
|
43
|
-
|
|
|
44
|
-
|
|
|
45
|
-
|
|
|
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,按风险选择 |
|
package/package-source/docs/codex-harness-engineering/templates/docs/requirement-prep-kit/README.md
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
# Requirement Prep Kit
|
|
2
|
-
|
|
3
|
-
本目录预留给需求收敛前的访谈、输入清洗、范围确认和验收准备模板。当前默认包不强制使用本目录;项目需要时可以在这里补充团队自己的需求准备表、访谈提纲或任务入口检查表。
|
|
1
|
+
# Requirement Prep Kit
|
|
2
|
+
|
|
3
|
+
本目录预留给需求收敛前的访谈、输入清洗、范围确认和验收准备模板。当前默认包不强制使用本目录;项目需要时可以在这里补充团队自己的需求准备表、访谈提纲或任务入口检查表。
|
|
@@ -1,98 +1,98 @@
|
|
|
1
|
-
# Harness Rule Governance
|
|
2
|
-
|
|
3
|
-
本文定义规则如何进入 `AGENTS.md`、深文档、prompt、task template 和自动化检查。目标是控制指令预算,同时让关键约束可执行、可验证、可演进。
|
|
4
|
-
|
|
5
|
-
## `docs/doc/1.md` 落地结论
|
|
6
|
-
|
|
7
|
-
`docs/doc/1.md` 的核心价值不是把模板原样搬进本仓库,而是约束规则系统的形态:
|
|
8
|
-
|
|
9
|
-
- `AGENTS.md` 做短入口,保留每次会话必须遵守的少量硬约束和深文档索引。
|
|
10
|
-
- AI 可以从代码、schema、lint 或脚本推断 / 检查的内容,不进入 `AGENTS.md`。
|
|
11
|
-
- 禁令必须带替代方案;例如不要伪造 `passes=true`,替代方案是让 `tools/harness/codex-loop.ps1` 在验证、review 和 commit gate 通过后写回状态。
|
|
12
|
-
- Bad Case 先进入知识、prompt、role rules 或自动化检查;只有所有会话都必须知道时,才升级到 `AGENTS.md`。
|
|
13
|
-
- 能自动检查的规则应进入 `tools/harness/verify.ps1`、`tools/harness/doctor.ps1`、JSON schema、hook 或同步脚本,不长期只靠文字提醒。
|
|
14
|
-
- 重要深文档必须被 `AGENTS.md` 引用,避免成为孤立文档。
|
|
15
|
-
|
|
16
|
-
本仓库实践选择:入口文件控制在“读完即可开工”的长度;任务、验证、知识、prompt 和镜像同步细节分别落到 `docs/harness/*`、`.codex/rules/*.md`、`.codex/prompts/*` 和 `agent/` package mirrors。官方自动加载的 `.codex/rules/*.rules` 只承载命令执行策略。
|
|
17
|
-
|
|
18
|
-
## 分层原则
|
|
19
|
-
|
|
20
|
-
| 层级 | 放什么 | 不放什么 |
|
|
21
|
-
| --- | --- | --- |
|
|
22
|
-
| `AGENTS.md` | 每次会话都必须遵守的少量硬约束、入口索引 | 长模板、通用编码常识、会频繁变动的细节 |
|
|
23
|
-
| `docs/harness/*` | driver、任务、验证、知识、治理等工程协议 | 具体业务需求 |
|
|
24
|
-
| `.codex/rules/*.rules` | Codex 官方 execpolicy:命令 allow / prompt / forbidden | agent 编排、测试原则、编码风格、项目 instruction |
|
|
25
|
-
| `.codex/rules/*.md` | agent 角色、阶段路由、协作边界等 Harness 语义规则 | 单个功能的临时计划;也不要误写成官方 execpolicy |
|
|
26
|
-
| `.codex/prompts/*` | driver 注入给实现、review、repair 的执行提示 | 人类阅读优先的长说明 |
|
|
27
|
-
| `task.json` | 当前真实任务队列和验证命令 | 模板示例、过期 smoke 占位 |
|
|
28
|
-
|
|
29
|
-
## 规则进入标准
|
|
30
|
-
|
|
31
|
-
只有满足以下至少一项,才应新增规则:
|
|
32
|
-
|
|
33
|
-
- 同类问题在 review、trace 或失败记录中重复出现。
|
|
34
|
-
- 违反后会造成安全、数据、提交、验证或上下文污染风险。
|
|
35
|
-
- AI 无法从代码和现有文档自然推断。
|
|
36
|
-
- 新人或新会话必须知道,否则会走错执行链路。
|
|
37
|
-
|
|
38
|
-
以下内容默认不写进规则:
|
|
39
|
-
|
|
40
|
-
- formatter、linter 已经确定性检查的风格细节。
|
|
41
|
-
- “写清晰代码”这类无法改变行为的泛化建议。
|
|
42
|
-
- README 面向人类读者的项目介绍。
|
|
43
|
-
- 没有验证方式的一次性偏好。
|
|
44
|
-
|
|
45
|
-
## 禁令写法
|
|
46
|
-
|
|
47
|
-
禁令必须同时给替代方案:
|
|
48
|
-
|
|
49
|
-
```text
|
|
50
|
-
不要直接改 task.json 来伪造完成状态;应让 tools/harness/codex-loop.ps1 在验证、review 和 commit gate 通过后写回 passes=true。
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
如果无法给替代方案,先不要写成硬规则,改写成待确认风险或知识条目。
|
|
54
|
-
|
|
55
|
-
## Bad Case 闭环
|
|
56
|
-
|
|
57
|
-
每次出现 AI 错误,先判断应该落到哪里:
|
|
58
|
-
|
|
59
|
-
| 错误类型 | 处理位置 |
|
|
60
|
-
| --- | --- |
|
|
61
|
-
| 单次任务失败 | `progress.txt`、trace、failure triage |
|
|
62
|
-
| 可复用经验 | `docs/knowledge/pitfalls/` 或 `guidelines/` |
|
|
63
|
-
| 会反复影响 driver 行为 | `.codex/prompts/*` 或 `.codex/rules/*.md` |
|
|
64
|
-
| 可确定为命令权限边界 | `.codex/rules/*.rules` |
|
|
65
|
-
| 所有会话必须知道 | `AGENTS.md` |
|
|
66
|
-
| 可以自动检查 | `tools/harness/verify.ps1`、`tools/harness/doctor.ps1`、JSON schema 或 hook |
|
|
67
|
-
|
|
68
|
-
## 变更流程
|
|
69
|
-
|
|
70
|
-
1. 先确认触发来源:trace、review finding、失败日志、用户明确要求或文档分析。
|
|
71
|
-
2. 选择最小生效层级,不把深文档内容直接搬进 `AGENTS.md`。
|
|
72
|
-
3. 如果改动影响模板或镜像,按 `harness-surface-sync` 同步 canonical source 和 mirrors。
|
|
73
|
-
4. 运行最小验证:文档至少 `git diff --check`,JSON 需要 `ConvertFrom-Json`,PowerShell 需要 parser 检查。
|
|
74
|
-
5. 提交前确认没有把 token、cookie、私钥、密码写入规则或 trace。
|
|
75
|
-
|
|
76
|
-
## 定期治理
|
|
77
|
-
|
|
78
|
-
建议每 10 个 driver 任务或每次较大 harness 改造后执行一次规则治理检查:
|
|
79
|
-
|
|
80
|
-
- `AGENTS.md` 是否仍保持短入口。
|
|
81
|
-
- 深文档是否有孤立规则没有被入口引用。
|
|
82
|
-
- prompt 是否与 `AGENTS.md`、`.codex/rules/agents.md` 冲突。
|
|
83
|
-
- `.codex/rules/*.rules` 是否仍只包含执行策略,且能通过 `codex execpolicy check`。
|
|
84
|
-
- task template 是否还包含 smoke、示例领域或占位路径。
|
|
85
|
-
- 知识条目是否有重复、过时、矛盾或长期未引用内容。
|
|
86
|
-
|
|
87
|
-
## AGENTS.md 压缩检查表
|
|
88
|
-
|
|
89
|
-
调整 `AGENTS.md` 时逐条检查:
|
|
90
|
-
|
|
91
|
-
| 问题 | 处理 |
|
|
92
|
-
| --- | --- |
|
|
93
|
-
| 这条规则是否每次会话都必须知道? | 是则保留,否则下沉到深文档 |
|
|
94
|
-
| 这条规则是否已有脚本、schema、lint 或 hook 检查? | 链接自动化位置,不重复写长说明 |
|
|
95
|
-
| 这条规则是否只是通用工程常识? | 删除 |
|
|
96
|
-
| 这条规则是否只有禁止项? | 补充替代方案,否则降级为风险说明 |
|
|
97
|
-
| 这条规则是否源自单次失败? | 先进入 `docs/knowledge/` 或 trace,不直接升级入口 |
|
|
98
|
-
| 深文档是否在入口可发现? | 在 `AGENTS.md` 索引补链接 |
|
|
1
|
+
# Harness Rule Governance
|
|
2
|
+
|
|
3
|
+
本文定义规则如何进入 `AGENTS.md`、深文档、prompt、task template 和自动化检查。目标是控制指令预算,同时让关键约束可执行、可验证、可演进。
|
|
4
|
+
|
|
5
|
+
## `docs/doc/1.md` 落地结论
|
|
6
|
+
|
|
7
|
+
`docs/doc/1.md` 的核心价值不是把模板原样搬进本仓库,而是约束规则系统的形态:
|
|
8
|
+
|
|
9
|
+
- `AGENTS.md` 做短入口,保留每次会话必须遵守的少量硬约束和深文档索引。
|
|
10
|
+
- AI 可以从代码、schema、lint 或脚本推断 / 检查的内容,不进入 `AGENTS.md`。
|
|
11
|
+
- 禁令必须带替代方案;例如不要伪造 `passes=true`,替代方案是让 `tools/harness/codex-loop.ps1` 在验证、review 和 commit gate 通过后写回状态。
|
|
12
|
+
- Bad Case 先进入知识、prompt、role rules 或自动化检查;只有所有会话都必须知道时,才升级到 `AGENTS.md`。
|
|
13
|
+
- 能自动检查的规则应进入 `tools/harness/verify.ps1`、`tools/harness/doctor.ps1`、JSON schema、hook 或同步脚本,不长期只靠文字提醒。
|
|
14
|
+
- 重要深文档必须被 `AGENTS.md` 引用,避免成为孤立文档。
|
|
15
|
+
|
|
16
|
+
本仓库实践选择:入口文件控制在“读完即可开工”的长度;任务、验证、知识、prompt 和镜像同步细节分别落到 `docs/harness/*`、`.codex/rules/*.md`、`.codex/prompts/*` 和 `agent/` package mirrors。官方自动加载的 `.codex/rules/*.rules` 只承载命令执行策略。
|
|
17
|
+
|
|
18
|
+
## 分层原则
|
|
19
|
+
|
|
20
|
+
| 层级 | 放什么 | 不放什么 |
|
|
21
|
+
| --- | --- | --- |
|
|
22
|
+
| `AGENTS.md` | 每次会话都必须遵守的少量硬约束、入口索引 | 长模板、通用编码常识、会频繁变动的细节 |
|
|
23
|
+
| `docs/harness/*` | driver、任务、验证、知识、治理等工程协议 | 具体业务需求 |
|
|
24
|
+
| `.codex/rules/*.rules` | Codex 官方 execpolicy:命令 allow / prompt / forbidden | agent 编排、测试原则、编码风格、项目 instruction |
|
|
25
|
+
| `.codex/rules/*.md` | agent 角色、阶段路由、协作边界等 Harness 语义规则 | 单个功能的临时计划;也不要误写成官方 execpolicy |
|
|
26
|
+
| `.codex/prompts/*` | driver 注入给实现、review、repair 的执行提示 | 人类阅读优先的长说明 |
|
|
27
|
+
| `task.json` | 当前真实任务队列和验证命令 | 模板示例、过期 smoke 占位 |
|
|
28
|
+
|
|
29
|
+
## 规则进入标准
|
|
30
|
+
|
|
31
|
+
只有满足以下至少一项,才应新增规则:
|
|
32
|
+
|
|
33
|
+
- 同类问题在 review、trace 或失败记录中重复出现。
|
|
34
|
+
- 违反后会造成安全、数据、提交、验证或上下文污染风险。
|
|
35
|
+
- AI 无法从代码和现有文档自然推断。
|
|
36
|
+
- 新人或新会话必须知道,否则会走错执行链路。
|
|
37
|
+
|
|
38
|
+
以下内容默认不写进规则:
|
|
39
|
+
|
|
40
|
+
- formatter、linter 已经确定性检查的风格细节。
|
|
41
|
+
- “写清晰代码”这类无法改变行为的泛化建议。
|
|
42
|
+
- README 面向人类读者的项目介绍。
|
|
43
|
+
- 没有验证方式的一次性偏好。
|
|
44
|
+
|
|
45
|
+
## 禁令写法
|
|
46
|
+
|
|
47
|
+
禁令必须同时给替代方案:
|
|
48
|
+
|
|
49
|
+
```text
|
|
50
|
+
不要直接改 task.json 来伪造完成状态;应让 tools/harness/codex-loop.ps1 在验证、review 和 commit gate 通过后写回 passes=true。
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
如果无法给替代方案,先不要写成硬规则,改写成待确认风险或知识条目。
|
|
54
|
+
|
|
55
|
+
## Bad Case 闭环
|
|
56
|
+
|
|
57
|
+
每次出现 AI 错误,先判断应该落到哪里:
|
|
58
|
+
|
|
59
|
+
| 错误类型 | 处理位置 |
|
|
60
|
+
| --- | --- |
|
|
61
|
+
| 单次任务失败 | `progress.txt`、trace、failure triage |
|
|
62
|
+
| 可复用经验 | `docs/knowledge/pitfalls/` 或 `guidelines/` |
|
|
63
|
+
| 会反复影响 driver 行为 | `.codex/prompts/*` 或 `.codex/rules/*.md` |
|
|
64
|
+
| 可确定为命令权限边界 | `.codex/rules/*.rules` |
|
|
65
|
+
| 所有会话必须知道 | `AGENTS.md` |
|
|
66
|
+
| 可以自动检查 | `tools/harness/verify.ps1`、`tools/harness/doctor.ps1`、JSON schema 或 hook |
|
|
67
|
+
|
|
68
|
+
## 变更流程
|
|
69
|
+
|
|
70
|
+
1. 先确认触发来源:trace、review finding、失败日志、用户明确要求或文档分析。
|
|
71
|
+
2. 选择最小生效层级,不把深文档内容直接搬进 `AGENTS.md`。
|
|
72
|
+
3. 如果改动影响模板或镜像,按 `harness-surface-sync` 同步 canonical source 和 mirrors。
|
|
73
|
+
4. 运行最小验证:文档至少 `git diff --check`,JSON 需要 `ConvertFrom-Json`,PowerShell 需要 parser 检查。
|
|
74
|
+
5. 提交前确认没有把 token、cookie、私钥、密码写入规则或 trace。
|
|
75
|
+
|
|
76
|
+
## 定期治理
|
|
77
|
+
|
|
78
|
+
建议每 10 个 driver 任务或每次较大 harness 改造后执行一次规则治理检查:
|
|
79
|
+
|
|
80
|
+
- `AGENTS.md` 是否仍保持短入口。
|
|
81
|
+
- 深文档是否有孤立规则没有被入口引用。
|
|
82
|
+
- prompt 是否与 `AGENTS.md`、`.codex/rules/agents.md` 冲突。
|
|
83
|
+
- `.codex/rules/*.rules` 是否仍只包含执行策略,且能通过 `codex execpolicy check`。
|
|
84
|
+
- task template 是否还包含 smoke、示例领域或占位路径。
|
|
85
|
+
- 知识条目是否有重复、过时、矛盾或长期未引用内容。
|
|
86
|
+
|
|
87
|
+
## AGENTS.md 压缩检查表
|
|
88
|
+
|
|
89
|
+
调整 `AGENTS.md` 时逐条检查:
|
|
90
|
+
|
|
91
|
+
| 问题 | 处理 |
|
|
92
|
+
| --- | --- |
|
|
93
|
+
| 这条规则是否每次会话都必须知道? | 是则保留,否则下沉到深文档 |
|
|
94
|
+
| 这条规则是否已有脚本、schema、lint 或 hook 检查? | 链接自动化位置,不重复写长说明 |
|
|
95
|
+
| 这条规则是否只是通用工程常识? | 删除 |
|
|
96
|
+
| 这条规则是否只有禁止项? | 补充替代方案,否则降级为风险说明 |
|
|
97
|
+
| 这条规则是否源自单次失败? | 先进入 `docs/knowledge/` 或 trace,不直接升级入口 |
|
|
98
|
+
| 深文档是否在入口可发现? | 在 `AGENTS.md` 索引补链接 |
|
package/package-source/docs/codex-harness-engineering/templates/docs/service-dependency-matrix.md
CHANGED
|
@@ -1,55 +1,70 @@
|
|
|
1
|
-
# Service Dependency Matrix
|
|
2
|
-
|
|
3
|
-
本文件说明 `.service-matrix/dependencies.yaml` 的维护口径。它是多服务、多仓库、IDL / API 契约或外部系统集成项目的可选 truth source;单体、小型前端或一次性脚本可以标记为 `not_applicable`。
|
|
4
|
-
|
|
5
|
-
## 适用条件
|
|
6
|
-
|
|
7
|
-
满足任一条件时,应启用服务依赖矩阵:
|
|
8
|
-
|
|
9
|
-
- 一个需求会修改或影响多个服务、包、仓库、worker、前端应用或脚本入口。
|
|
10
|
-
- 涉及 OpenAPI、protobuf、GraphQL schema、数据库 schema、消息事件、文件格式或第三方 API 契约。
|
|
11
|
-
- 需要确认上游调用方、下游依赖方、灰度、回滚、兼容性或分支一致性。
|
|
12
|
-
- 过去出现过“AI 只改了局部代码但漏掉调用链 / 契约 / 下游影响”的返工。
|
|
13
|
-
|
|
14
|
-
## 维护原则
|
|
15
|
-
|
|
16
|
-
- 矩阵只记录稳定拓扑和契约事实,不记录一次性任务过程。
|
|
17
|
-
- 不把矩阵写成项目百科;每条依赖必须能回答“谁依赖谁、通过什么契约、变更时检查什么”。
|
|
18
|
-
- 如果依赖需要人工确认,写 `status: needs-confirmation`,不得让实现任务继续猜。
|
|
19
|
-
- 如果某个项目不需要矩阵,在 `docs/architecture/constraints.md` 中写明 `service_matrix: not_applicable`。
|
|
20
|
-
|
|
21
|
-
## 最小字段
|
|
22
|
-
|
|
23
|
-
| 字段 | 说明 |
|
|
24
|
-
| --- | --- |
|
|
25
|
-
| `service_id` | 稳定服务、应用、包、worker 或集成名 |
|
|
26
|
-
| `repo_path` | 当前仓库内路径或外部仓库标识 |
|
|
27
|
-
| `entrypoints` | HTTP route、CLI command、worker、UI route、package export 等公开入口 |
|
|
28
|
-
| `contracts` | OpenAPI、protobuf、GraphQL、typed API、schema、event、file format 或 `none` |
|
|
29
|
-
| `upstream` | 调用本服务 / 包 / 入口的上游 |
|
|
30
|
-
| `downstream` | 本服务 / 包 / 入口调用的下游 |
|
|
31
|
-
| `change_gates` | 变更前必须通过的契约、分支、兼容性、灰度或回归检查 |
|
|
32
|
-
| `
|
|
33
|
-
| `
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
-
|
|
54
|
-
-
|
|
55
|
-
-
|
|
1
|
+
# Service Dependency Matrix
|
|
2
|
+
|
|
3
|
+
本文件说明 `.service-matrix/dependencies.yaml` 的维护口径。它是多服务、多仓库、IDL / API 契约或外部系统集成项目的可选 truth source;单体、小型前端或一次性脚本可以标记为 `not_applicable`。
|
|
4
|
+
|
|
5
|
+
## 适用条件
|
|
6
|
+
|
|
7
|
+
满足任一条件时,应启用服务依赖矩阵:
|
|
8
|
+
|
|
9
|
+
- 一个需求会修改或影响多个服务、包、仓库、worker、前端应用或脚本入口。
|
|
10
|
+
- 涉及 OpenAPI、protobuf、GraphQL schema、数据库 schema、消息事件、文件格式或第三方 API 契约。
|
|
11
|
+
- 需要确认上游调用方、下游依赖方、灰度、回滚、兼容性或分支一致性。
|
|
12
|
+
- 过去出现过“AI 只改了局部代码但漏掉调用链 / 契约 / 下游影响”的返工。
|
|
13
|
+
|
|
14
|
+
## 维护原则
|
|
15
|
+
|
|
16
|
+
- 矩阵只记录稳定拓扑和契约事实,不记录一次性任务过程。
|
|
17
|
+
- 不把矩阵写成项目百科;每条依赖必须能回答“谁依赖谁、通过什么契约、变更时检查什么”。
|
|
18
|
+
- 如果依赖需要人工确认,写 `status: needs-confirmation`,不得让实现任务继续猜。
|
|
19
|
+
- 如果某个项目不需要矩阵,在 `docs/architecture/constraints.md` 中写明 `service_matrix: not_applicable`。
|
|
20
|
+
|
|
21
|
+
## 最小字段
|
|
22
|
+
|
|
23
|
+
| 字段 | 说明 |
|
|
24
|
+
| --- | --- |
|
|
25
|
+
| `service_id` | 稳定服务、应用、包、worker 或集成名 |
|
|
26
|
+
| `repo_path` | 当前仓库内路径或外部仓库标识 |
|
|
27
|
+
| `entrypoints` | HTTP route、CLI command、worker、UI route、package export 等公开入口 |
|
|
28
|
+
| `contracts` | OpenAPI、protobuf、GraphQL、typed API、schema、event、file format 或 `none` |
|
|
29
|
+
| `upstream` | 调用本服务 / 包 / 入口的上游 |
|
|
30
|
+
| `downstream` | 本服务 / 包 / 入口调用的下游 |
|
|
31
|
+
| `change_gates` | 变更前必须通过的契约、分支、兼容性、灰度或回归检查 |
|
|
32
|
+
| `callback_webhook` | 回调、Webhook、验签入口或 `none` |
|
|
33
|
+
| `credential_source` | 凭据 / Secret 注入位置或 `none` |
|
|
34
|
+
| `retry_idempotency` | 外部调用的重试、幂等、去重策略 |
|
|
35
|
+
| `rate_limit_or_quota` | 第三方频率限制、配额或防刷规则 |
|
|
36
|
+
| `failure_fallback` | 超时、失败、降级、补偿或人工介入策略 |
|
|
37
|
+
| `owner` | 维护 owner 或确认人 |
|
|
38
|
+
| `status` | `active` / `draft` / `needs-confirmation` / `deprecated` / `not_applicable` |
|
|
39
|
+
|
|
40
|
+
## Driver 使用方式
|
|
41
|
+
|
|
42
|
+
- `ANALYSIS` 阶段识别本轮需求是否需要服务矩阵;需要时补齐 `.service-matrix/dependencies.yaml`。
|
|
43
|
+
- `PLAN` 阶段把受影响服务、契约和 change gates 映射到每个 `feature_impl` 的 `context_files`、`architecture_constraints`、`qa_contract` 和 `test_command`。
|
|
44
|
+
- `feature_impl` 阶段不得新增未声明的跨服务影响;发现矩阵缺失或不可信时输出 `BLOCKED`。
|
|
45
|
+
- `release` 阶段必须验证跨服务主链路、契约/API、失败态和回写证据。
|
|
46
|
+
|
|
47
|
+
## 第三方服务专项
|
|
48
|
+
|
|
49
|
+
如果依赖项属于支付、短信、邮件、推送、对象存储、上传扫描、OCR、AI API 或其他外部平台,矩阵至少补齐:
|
|
50
|
+
|
|
51
|
+
- 回调 / Webhook / 验签入口
|
|
52
|
+
- 凭据来源与注入位置
|
|
53
|
+
- 幂等 / 重试 / 超时 / 降级策略
|
|
54
|
+
- 频率限制、配额或防刷边界
|
|
55
|
+
- 失败时的人工介入、补偿或对账路径
|
|
56
|
+
|
|
57
|
+
## Review 口径
|
|
58
|
+
|
|
59
|
+
Stage 1 先检查矩阵是否足以支撑实现计划:
|
|
60
|
+
|
|
61
|
+
- 受影响服务是否都已列出。
|
|
62
|
+
- 上下游、契约、分支或版本约束是否明确。
|
|
63
|
+
- 是否有未确认依赖被实现任务当成已确认事实。
|
|
64
|
+
- 验证命令是否覆盖矩阵中的 change gates。
|
|
65
|
+
|
|
66
|
+
Stage 2 再检查代码是否真的遵守矩阵:
|
|
67
|
+
|
|
68
|
+
- 公开入口、契约、实现、测试和证据是否一致。
|
|
69
|
+
- 是否漏改下游调用、mock、生成代码、schema 或配置。
|
|
70
|
+
- 失败、回滚、兼容性和灰度路径是否有证据。
|