@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,187 +1,187 @@
|
|
|
1
|
-
# Team Knowledge Sync
|
|
2
|
-
|
|
3
|
-
本文定义项目级 `docs/knowledge/` 与可选团队知识库之间的同步协议。团队知识库是知识复利层,不是 driver 的运行依赖;没有外部知识库时,本地任务仍必须可以完成、验证和提交。
|
|
4
|
-
|
|
5
|
-
## 目标
|
|
6
|
-
|
|
7
|
-
- 把项目中已经验证的通用经验提升为团队资产。
|
|
8
|
-
- 让多个项目共享同一套技术知识、业务知识和团队约定。
|
|
9
|
-
- 用 Git、Markdown 和追加日志保留知识来源、贡献者、验证证据和冲突处理记录。
|
|
10
|
-
- 避免把未验证的单次经验直接升级为全局规则或团队规范。
|
|
11
|
-
|
|
12
|
-
## 推荐仓库结构
|
|
13
|
-
|
|
14
|
-
团队知识库建议独立成 Git 仓库,不寄生在任何业务项目中:
|
|
15
|
-
|
|
16
|
-
```text
|
|
17
|
-
team-knowledge/
|
|
18
|
-
knowledge-catalog.md # 团队级全景入口
|
|
19
|
-
.knowledge-config.yaml # 成员、角色、同步和冲突策略
|
|
20
|
-
log.md # 只追加的知识变更日志
|
|
21
|
-
team-conventions/ # Layer 0-T: 团队约定
|
|
22
|
-
tech-wiki/ # Layer 1: 跨项目技术知识
|
|
23
|
-
catalog.md
|
|
24
|
-
biz-wiki/<domain>/ # Layer 2: 领域业务知识
|
|
25
|
-
catalog.md
|
|
26
|
-
project-profiles/ # 项目画像和知识源映射
|
|
27
|
-
contributions/
|
|
28
|
-
pending/ # 待合并贡献
|
|
29
|
-
conflicts/ # 内容矛盾和人工裁决项
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
项目仓库只保存 Layer 3 项目知识:
|
|
33
|
-
|
|
34
|
-
```text
|
|
35
|
-
docs/knowledge/
|
|
36
|
-
knowledge-catalog.md
|
|
37
|
-
catalog.md
|
|
38
|
-
models/
|
|
39
|
-
decisions/
|
|
40
|
-
guidelines/
|
|
41
|
-
pitfalls/
|
|
42
|
-
processes/
|
|
43
|
-
archive/
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
## 角色
|
|
47
|
-
|
|
48
|
-
| 角色 | 权限 | 典型职责 |
|
|
49
|
-
| --- | --- | --- |
|
|
50
|
-
| `maintainer` | 审批 proven、裁决冲突、维护目录和成员 | 决定团队知识是否升级为约定、规则或模板 |
|
|
51
|
-
| `contributor` | 提交新条目、追加 evidence、标记冲突 | 从项目归档中输出 `contributions/pending/` |
|
|
52
|
-
| `reader` | 读取知识,不写入团队仓库 | 新成员、外部协作方、只读自动化 |
|
|
53
|
-
|
|
54
|
-
角色只影响团队知识库写入权限,不影响项目本地 `docs/knowledge/` 的归档任务。
|
|
55
|
-
|
|
56
|
-
## 配置建议
|
|
57
|
-
|
|
58
|
-
`.knowledge-config.yaml` 可使用以下最小形状:
|
|
59
|
-
|
|
60
|
-
```yaml
|
|
61
|
-
team:
|
|
62
|
-
name: example-team
|
|
63
|
-
default_role: reader
|
|
64
|
-
roles:
|
|
65
|
-
maintainers: []
|
|
66
|
-
contributors: []
|
|
67
|
-
sync:
|
|
68
|
-
accept_layers: [tech-wiki, biz-wiki]
|
|
69
|
-
default_domain:
|
|
70
|
-
require_maintainer_for_proven: true
|
|
71
|
-
conflicts:
|
|
72
|
-
on_content_conflict: stage_to_conflicts
|
|
73
|
-
on_maturity_conflict: keep_lower_and_mark_contradiction
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
项目 driver 不应依赖该配置存在。缺少配置时,只输出候选报告,不直接写外部仓库。
|
|
77
|
-
|
|
78
|
-
## 贡献流程
|
|
79
|
-
|
|
80
|
-
1. `ARCHIVE-*` 从本轮 trace、review、failure triage 和 `progress.txt` 中提取项目知识。
|
|
81
|
-
2. 条目先进入项目 `docs/knowledge/`,新增条目默认 `maturity: draft`。
|
|
82
|
-
3. `KNOWLEDGE-TEAM-SYNC-*` 只挑选具备跨项目价值的 `verified` 或 `proven` 候选。
|
|
83
|
-
4. 候选写入团队仓库 `contributions/pending/`,保留项目来源、贡献者、验证证据和建议目标层。
|
|
84
|
-
5. maintainer 审核后合入 `tech-wiki/`、`biz-wiki/<domain>/` 或 `team-conventions/`。
|
|
85
|
-
6. 合入时追加 `log.md`,记录日期、动作、贡献者、来源项目、条目 ID 和 evidence。
|
|
86
|
-
|
|
87
|
-
## 自动合并与冲突策略
|
|
88
|
-
|
|
89
|
-
| 情况 | 默认处理 |
|
|
90
|
-
| --- | --- |
|
|
91
|
-
| 不同 ID 的纯新增条目 | 可自动进入 `contributions/pending/` |
|
|
92
|
-
| 同一条目追加 `evidence`、`last_referenced` 或 `contributors` | 可自动合并并去重 |
|
|
93
|
-
| `draft -> verified` | 需要至少一个真实任务引用并有验证证据 |
|
|
94
|
-
| `verified -> proven` | 需要两个不同任务或项目的证据,或 maintainer 明确审批 |
|
|
95
|
-
| 内容结论相反 | 写入 `contributions/conflicts/`,等待 maintainer 裁决 |
|
|
96
|
-
| 一方提升成熟度、一方降级成熟度 | 保留较低成熟度并标记 `contradiction` |
|
|
97
|
-
| 删除或归档团队知识 | 必须有人类审批和 `log.md` 记录 |
|
|
98
|
-
|
|
99
|
-
自动化只能生成候选、追加 evidence、修复索引;不得静默删除团队知识或把单次经验提升为 `proven`。
|
|
100
|
-
|
|
101
|
-
## 追加日志
|
|
102
|
-
|
|
103
|
-
`log.md` 只追加,不重写历史。推荐格式:
|
|
104
|
-
|
|
105
|
-
```markdown
|
|
106
|
-
## [2026-05-12] promote | <contributor> | <source-project> | +1 guideline | #<trace-or-commit>
|
|
107
|
-
- GUIDELINE-API-001: 分页接口必须声明稳定排序字段 (verified -> proven)
|
|
108
|
-
```
|
|
109
|
-
|
|
110
|
-
每次团队知识变更至少记录:
|
|
111
|
-
|
|
112
|
-
- action: `ingest`、`verify`、`promote`、`decay`、`conflict`、`archive`
|
|
113
|
-
- contributor
|
|
114
|
-
- source project
|
|
115
|
-
- source trace、commit、review finding 或文档路径
|
|
116
|
-
- affected knowledge IDs
|
|
117
|
-
|
|
118
|
-
## 条目元数据补充
|
|
119
|
-
|
|
120
|
-
团队知识条目除项目知识的基本 frontmatter 外,建议补充:
|
|
121
|
-
|
|
122
|
-
```yaml
|
|
123
|
-
evidence:
|
|
124
|
-
contributors:
|
|
125
|
-
- name: codex
|
|
126
|
-
source_project: example-project
|
|
127
|
-
source_ref: traces/TASK-001-20260512.json
|
|
128
|
-
last_referenced:
|
|
129
|
-
validated_projects: []
|
|
130
|
-
contradictions: []
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
如果项目知识仍使用简化 frontmatter,也应在同步候选里补齐 evidence,而不是丢失来源。
|
|
134
|
-
|
|
135
|
-
## 降级与失败处理
|
|
136
|
-
|
|
137
|
-
- 团队知识仓库不可用时,任务只能记录 `blocked_external_knowledge_sync` 或输出候选报告,不应阻塞本地实现验证。
|
|
138
|
-
- 外部仓库 push 失败时,不要伪造已同步状态;把候选保留在项目报告或本地 pending 文件里。
|
|
139
|
-
- 外部知识和项目事实冲突时,以当前项目可验证事实为准,并输出 conflict candidate。
|
|
140
|
-
- 衰减和归档必须先形成候选,再由 maintainer 或独立任务确认。
|
|
141
|
-
|
|
142
|
-
## 任务模板片段
|
|
143
|
-
|
|
144
|
-
需要把团队知识同步加入 `task.json` 时,可按项目裁剪以下任务。该任务是可选上层能力,不应成为所有项目的默认阻塞任务。
|
|
145
|
-
|
|
146
|
-
```json
|
|
147
|
-
{
|
|
148
|
-
"id": "KNOWLEDGE-TEAM-SYNC-001",
|
|
149
|
-
"description": "把项目知识中的跨项目候选输出到团队知识库贡献暂存区",
|
|
150
|
-
"task_kind": "archive",
|
|
151
|
-
"phase": "archive",
|
|
152
|
-
"gate_profile": "lightweight",
|
|
153
|
-
"required_truth_sources": ["knowledge"],
|
|
154
|
-
"priority": 95,
|
|
155
|
-
"dependencies": ["ARCHIVE-001"],
|
|
156
|
-
"passes": false,
|
|
157
|
-
"context_files": [
|
|
158
|
-
"docs/harness/knowledge-architecture.md",
|
|
159
|
-
"docs/harness/team-knowledge-sync.md",
|
|
160
|
-
"docs/knowledge/knowledge-catalog.md",
|
|
161
|
-
"docs/knowledge/catalog.md"
|
|
162
|
-
],
|
|
163
|
-
"owned_paths": [
|
|
164
|
-
"docs/knowledge/"
|
|
165
|
-
],
|
|
166
|
-
"execution": { "mode": "single" },
|
|
167
|
-
"steps": [
|
|
168
|
-
"读取 promotion candidates,筛选具备跨项目价值的 verified/proven 条目",
|
|
169
|
-
"如果团队知识库可用,输出 contributions/pending 候选并追加同步报告",
|
|
170
|
-
"如果团队知识库不可用,仅在项目内记录候选、缺失配置和后续人工步骤",
|
|
171
|
-
"内容冲突写入 conflict candidate,不直接覆盖团队知识"
|
|
172
|
-
],
|
|
173
|
-
"test_command": "git diff --check",
|
|
174
|
-
"acceptance": [
|
|
175
|
-
"同步结果或候选报告可追溯到项目知识条目和 evidence",
|
|
176
|
-
"没有把 draft 或单次经验直接升级为团队 proven 知识",
|
|
177
|
-
"外部团队知识库不可用时没有阻塞本地 driver 验证"
|
|
178
|
-
]
|
|
179
|
-
}
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
## 相关文档
|
|
183
|
-
|
|
184
|
-
- 项目知识架构:`docs/harness/knowledge-architecture.md`
|
|
185
|
-
- 冷启动导入:`docs/harness/knowledge-import.md`
|
|
186
|
-
- 知识健康检查:`docs/harness/knowledge-lint.md`
|
|
187
|
-
- Prompt 知识集成:`docs/harness/prompt-knowledge-integration.md`
|
|
1
|
+
# Team Knowledge Sync
|
|
2
|
+
|
|
3
|
+
本文定义项目级 `docs/knowledge/` 与可选团队知识库之间的同步协议。团队知识库是知识复利层,不是 driver 的运行依赖;没有外部知识库时,本地任务仍必须可以完成、验证和提交。
|
|
4
|
+
|
|
5
|
+
## 目标
|
|
6
|
+
|
|
7
|
+
- 把项目中已经验证的通用经验提升为团队资产。
|
|
8
|
+
- 让多个项目共享同一套技术知识、业务知识和团队约定。
|
|
9
|
+
- 用 Git、Markdown 和追加日志保留知识来源、贡献者、验证证据和冲突处理记录。
|
|
10
|
+
- 避免把未验证的单次经验直接升级为全局规则或团队规范。
|
|
11
|
+
|
|
12
|
+
## 推荐仓库结构
|
|
13
|
+
|
|
14
|
+
团队知识库建议独立成 Git 仓库,不寄生在任何业务项目中:
|
|
15
|
+
|
|
16
|
+
```text
|
|
17
|
+
team-knowledge/
|
|
18
|
+
knowledge-catalog.md # 团队级全景入口
|
|
19
|
+
.knowledge-config.yaml # 成员、角色、同步和冲突策略
|
|
20
|
+
log.md # 只追加的知识变更日志
|
|
21
|
+
team-conventions/ # Layer 0-T: 团队约定
|
|
22
|
+
tech-wiki/ # Layer 1: 跨项目技术知识
|
|
23
|
+
catalog.md
|
|
24
|
+
biz-wiki/<domain>/ # Layer 2: 领域业务知识
|
|
25
|
+
catalog.md
|
|
26
|
+
project-profiles/ # 项目画像和知识源映射
|
|
27
|
+
contributions/
|
|
28
|
+
pending/ # 待合并贡献
|
|
29
|
+
conflicts/ # 内容矛盾和人工裁决项
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
项目仓库只保存 Layer 3 项目知识:
|
|
33
|
+
|
|
34
|
+
```text
|
|
35
|
+
docs/knowledge/
|
|
36
|
+
knowledge-catalog.md
|
|
37
|
+
catalog.md
|
|
38
|
+
models/
|
|
39
|
+
decisions/
|
|
40
|
+
guidelines/
|
|
41
|
+
pitfalls/
|
|
42
|
+
processes/
|
|
43
|
+
archive/
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## 角色
|
|
47
|
+
|
|
48
|
+
| 角色 | 权限 | 典型职责 |
|
|
49
|
+
| --- | --- | --- |
|
|
50
|
+
| `maintainer` | 审批 proven、裁决冲突、维护目录和成员 | 决定团队知识是否升级为约定、规则或模板 |
|
|
51
|
+
| `contributor` | 提交新条目、追加 evidence、标记冲突 | 从项目归档中输出 `contributions/pending/` |
|
|
52
|
+
| `reader` | 读取知识,不写入团队仓库 | 新成员、外部协作方、只读自动化 |
|
|
53
|
+
|
|
54
|
+
角色只影响团队知识库写入权限,不影响项目本地 `docs/knowledge/` 的归档任务。
|
|
55
|
+
|
|
56
|
+
## 配置建议
|
|
57
|
+
|
|
58
|
+
`.knowledge-config.yaml` 可使用以下最小形状:
|
|
59
|
+
|
|
60
|
+
```yaml
|
|
61
|
+
team:
|
|
62
|
+
name: example-team
|
|
63
|
+
default_role: reader
|
|
64
|
+
roles:
|
|
65
|
+
maintainers: []
|
|
66
|
+
contributors: []
|
|
67
|
+
sync:
|
|
68
|
+
accept_layers: [tech-wiki, biz-wiki]
|
|
69
|
+
default_domain:
|
|
70
|
+
require_maintainer_for_proven: true
|
|
71
|
+
conflicts:
|
|
72
|
+
on_content_conflict: stage_to_conflicts
|
|
73
|
+
on_maturity_conflict: keep_lower_and_mark_contradiction
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
项目 driver 不应依赖该配置存在。缺少配置时,只输出候选报告,不直接写外部仓库。
|
|
77
|
+
|
|
78
|
+
## 贡献流程
|
|
79
|
+
|
|
80
|
+
1. `ARCHIVE-*` 从本轮 trace、review、failure triage 和 `progress.txt` 中提取项目知识。
|
|
81
|
+
2. 条目先进入项目 `docs/knowledge/`,新增条目默认 `maturity: draft`。
|
|
82
|
+
3. `KNOWLEDGE-TEAM-SYNC-*` 只挑选具备跨项目价值的 `verified` 或 `proven` 候选。
|
|
83
|
+
4. 候选写入团队仓库 `contributions/pending/`,保留项目来源、贡献者、验证证据和建议目标层。
|
|
84
|
+
5. maintainer 审核后合入 `tech-wiki/`、`biz-wiki/<domain>/` 或 `team-conventions/`。
|
|
85
|
+
6. 合入时追加 `log.md`,记录日期、动作、贡献者、来源项目、条目 ID 和 evidence。
|
|
86
|
+
|
|
87
|
+
## 自动合并与冲突策略
|
|
88
|
+
|
|
89
|
+
| 情况 | 默认处理 |
|
|
90
|
+
| --- | --- |
|
|
91
|
+
| 不同 ID 的纯新增条目 | 可自动进入 `contributions/pending/` |
|
|
92
|
+
| 同一条目追加 `evidence`、`last_referenced` 或 `contributors` | 可自动合并并去重 |
|
|
93
|
+
| `draft -> verified` | 需要至少一个真实任务引用并有验证证据 |
|
|
94
|
+
| `verified -> proven` | 需要两个不同任务或项目的证据,或 maintainer 明确审批 |
|
|
95
|
+
| 内容结论相反 | 写入 `contributions/conflicts/`,等待 maintainer 裁决 |
|
|
96
|
+
| 一方提升成熟度、一方降级成熟度 | 保留较低成熟度并标记 `contradiction` |
|
|
97
|
+
| 删除或归档团队知识 | 必须有人类审批和 `log.md` 记录 |
|
|
98
|
+
|
|
99
|
+
自动化只能生成候选、追加 evidence、修复索引;不得静默删除团队知识或把单次经验提升为 `proven`。
|
|
100
|
+
|
|
101
|
+
## 追加日志
|
|
102
|
+
|
|
103
|
+
`log.md` 只追加,不重写历史。推荐格式:
|
|
104
|
+
|
|
105
|
+
```markdown
|
|
106
|
+
## [2026-05-12] promote | <contributor> | <source-project> | +1 guideline | #<trace-or-commit>
|
|
107
|
+
- GUIDELINE-API-001: 分页接口必须声明稳定排序字段 (verified -> proven)
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
每次团队知识变更至少记录:
|
|
111
|
+
|
|
112
|
+
- action: `ingest`、`verify`、`promote`、`decay`、`conflict`、`archive`
|
|
113
|
+
- contributor
|
|
114
|
+
- source project
|
|
115
|
+
- source trace、commit、review finding 或文档路径
|
|
116
|
+
- affected knowledge IDs
|
|
117
|
+
|
|
118
|
+
## 条目元数据补充
|
|
119
|
+
|
|
120
|
+
团队知识条目除项目知识的基本 frontmatter 外,建议补充:
|
|
121
|
+
|
|
122
|
+
```yaml
|
|
123
|
+
evidence:
|
|
124
|
+
contributors:
|
|
125
|
+
- name: codex
|
|
126
|
+
source_project: example-project
|
|
127
|
+
source_ref: traces/TASK-001-20260512.json
|
|
128
|
+
last_referenced:
|
|
129
|
+
validated_projects: []
|
|
130
|
+
contradictions: []
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
如果项目知识仍使用简化 frontmatter,也应在同步候选里补齐 evidence,而不是丢失来源。
|
|
134
|
+
|
|
135
|
+
## 降级与失败处理
|
|
136
|
+
|
|
137
|
+
- 团队知识仓库不可用时,任务只能记录 `blocked_external_knowledge_sync` 或输出候选报告,不应阻塞本地实现验证。
|
|
138
|
+
- 外部仓库 push 失败时,不要伪造已同步状态;把候选保留在项目报告或本地 pending 文件里。
|
|
139
|
+
- 外部知识和项目事实冲突时,以当前项目可验证事实为准,并输出 conflict candidate。
|
|
140
|
+
- 衰减和归档必须先形成候选,再由 maintainer 或独立任务确认。
|
|
141
|
+
|
|
142
|
+
## 任务模板片段
|
|
143
|
+
|
|
144
|
+
需要把团队知识同步加入 `task.json` 时,可按项目裁剪以下任务。该任务是可选上层能力,不应成为所有项目的默认阻塞任务。
|
|
145
|
+
|
|
146
|
+
```json
|
|
147
|
+
{
|
|
148
|
+
"id": "KNOWLEDGE-TEAM-SYNC-001",
|
|
149
|
+
"description": "把项目知识中的跨项目候选输出到团队知识库贡献暂存区",
|
|
150
|
+
"task_kind": "archive",
|
|
151
|
+
"phase": "archive",
|
|
152
|
+
"gate_profile": "lightweight",
|
|
153
|
+
"required_truth_sources": ["knowledge"],
|
|
154
|
+
"priority": 95,
|
|
155
|
+
"dependencies": ["ARCHIVE-001"],
|
|
156
|
+
"passes": false,
|
|
157
|
+
"context_files": [
|
|
158
|
+
"docs/harness/knowledge-architecture.md",
|
|
159
|
+
"docs/harness/team-knowledge-sync.md",
|
|
160
|
+
"docs/knowledge/knowledge-catalog.md",
|
|
161
|
+
"docs/knowledge/catalog.md"
|
|
162
|
+
],
|
|
163
|
+
"owned_paths": [
|
|
164
|
+
"docs/knowledge/"
|
|
165
|
+
],
|
|
166
|
+
"execution": { "mode": "single" },
|
|
167
|
+
"steps": [
|
|
168
|
+
"读取 promotion candidates,筛选具备跨项目价值的 verified/proven 条目",
|
|
169
|
+
"如果团队知识库可用,输出 contributions/pending 候选并追加同步报告",
|
|
170
|
+
"如果团队知识库不可用,仅在项目内记录候选、缺失配置和后续人工步骤",
|
|
171
|
+
"内容冲突写入 conflict candidate,不直接覆盖团队知识"
|
|
172
|
+
],
|
|
173
|
+
"test_command": "git diff --check",
|
|
174
|
+
"acceptance": [
|
|
175
|
+
"同步结果或候选报告可追溯到项目知识条目和 evidence",
|
|
176
|
+
"没有把 draft 或单次经验直接升级为团队 proven 知识",
|
|
177
|
+
"外部团队知识库不可用时没有阻塞本地 driver 验证"
|
|
178
|
+
]
|
|
179
|
+
}
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
## 相关文档
|
|
183
|
+
|
|
184
|
+
- 项目知识架构:`docs/harness/knowledge-architecture.md`
|
|
185
|
+
- 冷启动导入:`docs/harness/knowledge-import.md`
|
|
186
|
+
- 知识健康检查:`docs/harness/knowledge-lint.md`
|
|
187
|
+
- Prompt 知识集成:`docs/harness/prompt-knowledge-integration.md`
|
|
@@ -39,36 +39,48 @@ traces/<task-id>-<yyyyMMdd-HHmmss>.json
|
|
|
39
39
|
| `files_changed` | array | Git 检测到的文件 |
|
|
40
40
|
| `blocked_reason` | string/null | 阻塞原因 |
|
|
41
41
|
| `final_message` | string | Codex 最终消息摘要 |
|
|
42
|
-
| `test_command` | string | 当前任务验证命令 |
|
|
43
|
-
| `qa_evidence` | object/null | 测试用例、Oracle、证据文件、副作用断言、假测试检测和失败复现摘要 |
|
|
44
|
-
| `failed_stage` | string/null | 失败发生在哪个 gate |
|
|
42
|
+
| `test_command` | string | 当前任务验证命令 |
|
|
43
|
+
| `qa_evidence` | object/null | 测试用例、Oracle、证据文件、副作用断言、假测试检测和失败复现摘要 |
|
|
44
|
+
| `failed_stage` | string/null | 失败发生在哪个 gate |
|
|
45
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 执行。
|
|
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,18 @@
|
|
|
1
|
+
# AGENTS.md
|
|
2
|
+
|
|
3
|
+
## 目录作用
|
|
4
|
+
|
|
5
|
+
- 存放治理侧的策略、风险分级、保护清单和反馈回路模板。
|
|
6
|
+
|
|
7
|
+
## 结构索引
|
|
8
|
+
|
|
9
|
+
- `sandbox-policy.md`:权限和沙箱策略。
|
|
10
|
+
- `risk-levels.yaml`:风险分级。
|
|
11
|
+
- `retry-budget.yaml`:重试预算。
|
|
12
|
+
- `branch-protection-checklist.md`:分支保护清单。
|
|
13
|
+
- `feedback-evolution-loop.md`:经验回流机制。
|
|
14
|
+
|
|
15
|
+
## 修改规则
|
|
16
|
+
|
|
17
|
+
- 这里定义的是“治理口径”,不是具体 task 细节。
|
|
18
|
+
- 修改风险分级或策略时,要检查 driver、review 和 docs 是否需要同步解释。
|
|
@@ -1,50 +1,50 @@
|
|
|
1
|
-
# Branch Protection Checklist 模板
|
|
2
|
-
|
|
3
|
-
## 1. 受保护分支
|
|
4
|
-
|
|
5
|
-
- [ ] `main`
|
|
6
|
-
- [ ] `release/*`
|
|
7
|
-
- [ ] `hotfix/*`
|
|
8
|
-
|
|
9
|
-
## 2. Required Status Checks
|
|
10
|
-
|
|
11
|
-
- [ ] `lint`
|
|
12
|
-
- [ ] `typecheck`
|
|
13
|
-
- [ ] `unit-test`
|
|
14
|
-
- [ ] `build`
|
|
15
|
-
- [ ] `contract-validate`
|
|
16
|
-
- [ ] `e2e`
|
|
17
|
-
- [ ] `visual-regression`
|
|
18
|
-
- [ ] `codex-stage1-review`
|
|
19
|
-
- [ ] `codex-stage2-review`
|
|
20
|
-
|
|
21
|
-
说明:
|
|
22
|
-
|
|
23
|
-
- GitHub required checks 对 GitHub Actions 使用的是 **job name**,不是 step 名。
|
|
24
|
-
- required checks 使用的 job 名必须在所有 workflow 中唯一,避免出现歧义。
|
|
25
|
-
- 如果某个 required check job 依赖其他 job,建议配合 `needs` + `always()`,确保检查名始终实际出现。
|
|
26
|
-
|
|
27
|
-
## 3. 合并策略
|
|
28
|
-
|
|
29
|
-
- [ ] 禁止绕过 required status checks
|
|
30
|
-
- [ ] 禁止在 checks 缺失时自动合并
|
|
31
|
-
- [ ] 仅允许 squash / merge / rebase 中的指定策略
|
|
32
|
-
- [ ] L2/L3 风险变更必须人工审批
|
|
33
|
-
|
|
34
|
-
## 4. Review 策略
|
|
35
|
-
|
|
36
|
-
- [ ] 至少 1 位 reviewer
|
|
37
|
-
- [ ] 高风险目录要求指定 owner 审核
|
|
38
|
-
- [ ] AI 自动 PR 不得自审自合
|
|
39
|
-
|
|
40
|
-
## 5. 特权与例外
|
|
41
|
-
|
|
42
|
-
- 可 bypass 的角色:
|
|
43
|
-
- 可 bypass 的场景:
|
|
44
|
-
- 需要补追溯记录的场景:
|
|
45
|
-
|
|
46
|
-
## 6. 上线前检查
|
|
47
|
-
|
|
48
|
-
- [ ] 回滚方案可用
|
|
49
|
-
- [ ] smoke test 已运行
|
|
50
|
-
- [ ] 关键监控已开启
|
|
1
|
+
# Branch Protection Checklist 模板
|
|
2
|
+
|
|
3
|
+
## 1. 受保护分支
|
|
4
|
+
|
|
5
|
+
- [ ] `main`
|
|
6
|
+
- [ ] `release/*`
|
|
7
|
+
- [ ] `hotfix/*`
|
|
8
|
+
|
|
9
|
+
## 2. Required Status Checks
|
|
10
|
+
|
|
11
|
+
- [ ] `lint`
|
|
12
|
+
- [ ] `typecheck`
|
|
13
|
+
- [ ] `unit-test`
|
|
14
|
+
- [ ] `build`
|
|
15
|
+
- [ ] `contract-validate`
|
|
16
|
+
- [ ] `e2e`
|
|
17
|
+
- [ ] `visual-regression`
|
|
18
|
+
- [ ] `codex-stage1-review`
|
|
19
|
+
- [ ] `codex-stage2-review`
|
|
20
|
+
|
|
21
|
+
说明:
|
|
22
|
+
|
|
23
|
+
- GitHub required checks 对 GitHub Actions 使用的是 **job name**,不是 step 名。
|
|
24
|
+
- required checks 使用的 job 名必须在所有 workflow 中唯一,避免出现歧义。
|
|
25
|
+
- 如果某个 required check job 依赖其他 job,建议配合 `needs` + `always()`,确保检查名始终实际出现。
|
|
26
|
+
|
|
27
|
+
## 3. 合并策略
|
|
28
|
+
|
|
29
|
+
- [ ] 禁止绕过 required status checks
|
|
30
|
+
- [ ] 禁止在 checks 缺失时自动合并
|
|
31
|
+
- [ ] 仅允许 squash / merge / rebase 中的指定策略
|
|
32
|
+
- [ ] L2/L3 风险变更必须人工审批
|
|
33
|
+
|
|
34
|
+
## 4. Review 策略
|
|
35
|
+
|
|
36
|
+
- [ ] 至少 1 位 reviewer
|
|
37
|
+
- [ ] 高风险目录要求指定 owner 审核
|
|
38
|
+
- [ ] AI 自动 PR 不得自审自合
|
|
39
|
+
|
|
40
|
+
## 5. 特权与例外
|
|
41
|
+
|
|
42
|
+
- 可 bypass 的角色:
|
|
43
|
+
- 可 bypass 的场景:
|
|
44
|
+
- 需要补追溯记录的场景:
|
|
45
|
+
|
|
46
|
+
## 6. 上线前检查
|
|
47
|
+
|
|
48
|
+
- [ ] 回滚方案可用
|
|
49
|
+
- [ ] smoke test 已运行
|
|
50
|
+
- [ ] 关键监控已开启
|