@williambeto/ai-workflow 1.19.1 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +56 -838
- package/PUBLISH_MANIFEST.json +34 -0
- package/README.md +70 -149
- package/{packages/ai-workflow/bin → bin}/ai-workflow.js +0 -0
- package/dist-assets/AGENTS.md +27 -0
- package/dist-assets/agents/astra.md +63 -0
- package/dist-assets/agents/atlas.md +169 -0
- package/dist-assets/agents/nexus.md +42 -0
- package/dist-assets/agents/orion.md +44 -0
- package/dist-assets/agents/phoenix.md +42 -0
- package/dist-assets/agents/sage.md +54 -0
- package/dist-assets/commands/README.md +14 -0
- package/dist-assets/commands/atlas.md +12 -0
- package/dist-assets/commands/audit.md +10 -0
- package/dist-assets/commands/deploy.md +12 -0
- package/dist-assets/commands/discover.md +10 -0
- package/dist-assets/commands/implement.md +28 -0
- package/dist-assets/commands/optimize-tokens.md +10 -0
- package/dist-assets/commands/plan.md +10 -0
- package/dist-assets/commands/release.md +12 -0
- package/dist-assets/commands/run.md +26 -0
- package/dist-assets/commands/spec-create.md +10 -0
- package/dist-assets/commands/spec-implement.md +10 -0
- package/dist-assets/commands/spec-review.md +10 -0
- package/dist-assets/commands/update-memory.md +10 -0
- package/dist-assets/commands/validate.md +12 -0
- package/dist-assets/docs/INDEX.md +21 -0
- package/dist-assets/docs/QUICKSTART.md +23 -0
- package/dist-assets/docs/adr/ADR-0000.md +19 -0
- package/dist-assets/docs/adr/ADR-0001.md +45 -0
- package/dist-assets/docs/adr/ADR-0002.md +62 -0
- package/dist-assets/docs/adr/ADR-0003.md +60 -0
- package/dist-assets/docs/adr/ADR-0004.md +71 -0
- package/dist-assets/docs/adr/ADR-0005.md +22 -0
- package/dist-assets/docs/adr/ADR-0006.md +82 -0
- package/dist-assets/docs/adr/ADR-0007.md +78 -0
- package/dist-assets/docs/api-engine-reference.md +7 -0
- package/{docs → dist-assets/docs}/architecture-policy.md +1 -1
- package/dist-assets/docs/cli-reference.md +27 -0
- package/dist-assets/docs/compatibility/provider-usage.md +38 -0
- package/dist-assets/docs/compatibility/runtime-matrix.md +30 -0
- package/dist-assets/docs/consumer-onboarding.md +17 -0
- package/dist-assets/docs/contributing-guide.md +11 -0
- package/{docs → dist-assets/docs}/design-patterns-policy.md +2 -2
- package/dist-assets/docs/full-documentation.md +113 -0
- package/{docs → dist-assets/docs}/npm-consumer-quickstart.md +18 -46
- package/dist-assets/docs/opencode-readme.md +8 -0
- package/dist-assets/docs/policies/01-BRANCH_GATE.md +63 -0
- package/dist-assets/docs/policies/02-SDD_METHODOLOGY.md +95 -0
- package/dist-assets/docs/policies/03-QUALITY_GATE.md +22 -0
- package/dist-assets/docs/policies/05-AGENT_CONTRACT.md +7 -0
- package/dist-assets/docs/policies/06-FINAL_EVIDENCE_CONTRACT.md +31 -0
- package/dist-assets/docs/policies/07-RELEASE_GATE.md +47 -0
- package/dist-assets/docs/policies/08-PRODUCT_TRUTHFULNESS_AND_PROJECT_DOCS.md +18 -0
- package/dist-assets/docs/policies/09-SPEC_VISIBILITY_AND_PUBLICATION.md +28 -0
- package/dist-assets/docs/policies/10-BEHAVIORAL_CONTRACT_HARDENING.md +9 -0
- package/dist-assets/docs/policies/11-EXECUTABLE_DELEGATION_AND_TRUTHFULNESS.md +7 -0
- package/dist-assets/docs/policies/ORCHESTRATION_PROTOCOL.md +15 -0
- package/dist-assets/docs/policies/PROCEDURE_DELIVERY_ARTIFACTS.md +21 -0
- package/dist-assets/docs/policies/PROCEDURE_DOCUMENTATION_CHECKLIST.md +24 -0
- package/dist-assets/docs/policies/PROCEDURE_UI_CHECKLIST.md +54 -0
- package/dist-assets/docs/profiles/README.md +19 -0
- package/dist-assets/docs/profiles/backend-api.md +5 -0
- package/dist-assets/docs/profiles/documentation.md +3 -0
- package/dist-assets/docs/profiles/frontend-product.md +19 -0
- package/dist-assets/docs/profiles/frontend-utility.md +19 -0
- package/dist-assets/docs/profiles/refactor.md +3 -0
- package/dist-assets/docs/profiles/security-review.md +3 -0
- package/dist-assets/docs/references/frontend-quality/landing-page-quality-checklist.md +11 -0
- package/dist-assets/docs/references/frontend-quality/product-copy-truthfulness.md +7 -0
- package/dist-assets/docs/references/frontend-quality/quality-failure-examples.md +20 -0
- package/dist-assets/docs/references/frontend-quality/visual-composition-patterns.md +10 -0
- package/dist-assets/docs/specs/runtime-operational-contract.md +39 -0
- package/dist-assets/docs/troubleshooting-guide.md +21 -0
- package/dist-assets/examples/README.md +10 -0
- package/dist-assets/examples/autopilot-cycle/00-CONTEXT.md +3 -0
- package/dist-assets/examples/autopilot-cycle/01-requirement.md +16 -0
- package/dist-assets/examples/autopilot-cycle/02-gate-a-check.md +23 -0
- package/dist-assets/examples/autopilot-cycle/03-orion-planning.md +20 -0
- package/dist-assets/examples/autopilot-cycle/04-astra-implementation.md +17 -0
- package/dist-assets/examples/autopilot-cycle/05-sage-validation.md +15 -0
- package/dist-assets/examples/autopilot-cycle/06-phoenix-healing.md +12 -0
- package/dist-assets/examples/autopilot-cycle/07-orchestration-report.md +18 -0
- package/dist-assets/examples/backend-api/00-CONTEXT.md +12 -0
- package/dist-assets/examples/backend-api/01-requirement.md +19 -0
- package/dist-assets/examples/backend-api/02-functional-spec.md +20 -0
- package/dist-assets/examples/backend-api/03-technical-plan.md +15 -0
- package/dist-assets/examples/backend-api/04-pr-breakdown.md +10 -0
- package/dist-assets/examples/backend-api/05-execution-handoff.md +13 -0
- package/dist-assets/examples/backend-api/06-validation-report.md +11 -0
- package/dist-assets/examples/backend-api/07-orchestration-report.md +7 -0
- package/dist-assets/examples/blocked-scenarios/00-CONTEXT.md +9 -0
- package/dist-assets/examples/blocked-scenarios/01-branch-gate-block.md +12 -0
- package/dist-assets/examples/blocked-scenarios/02-quality-gate-block.md +13 -0
- package/dist-assets/examples/blocked-scenarios/03-scope-creep-block.md +13 -0
- package/dist-assets/examples/blocked-scenarios/04-unblock-resolution.md +9 -0
- package/dist-assets/examples/blocked-scenarios/05-orchestration-decision-log.md +11 -0
- package/dist-assets/examples/bugfix-critical/00-CONTEXT.md +12 -0
- package/dist-assets/examples/bugfix-critical/01-bug-report.md +11 -0
- package/dist-assets/examples/bugfix-critical/02-diagnosis-hypothesis.md +11 -0
- package/dist-assets/examples/bugfix-critical/03-technical-plan.md +12 -0
- package/dist-assets/examples/bugfix-critical/04-implementation-handoff.md +8 -0
- package/dist-assets/examples/bugfix-critical/05-validation-report.md +10 -0
- package/dist-assets/examples/bugfix-critical/06-orchestration-report.md +7 -0
- package/dist-assets/examples/cli-package/00-CONTEXT.md +9 -0
- package/dist-assets/examples/cli-package/01-requirement.md +14 -0
- package/dist-assets/examples/cli-package/02-technical-spec.md +16 -0
- package/dist-assets/examples/cli-package/03-technical-plan.md +12 -0
- package/dist-assets/examples/cli-package/04-pr-breakdown.md +9 -0
- package/dist-assets/examples/cli-package/05-release-report.md +15 -0
- package/dist-assets/examples/docs-only-repo/01-requirement.md +31 -0
- package/dist-assets/examples/docs-only-repo/02-functional-spec.md +25 -0
- package/dist-assets/examples/docs-only-repo/03-technical-plan.md +21 -0
- package/dist-assets/examples/docs-only-repo/04-pr-breakdown.md +13 -0
- package/dist-assets/examples/docs-only-repo/05-execution-handoff.md +17 -0
- package/dist-assets/examples/docs-only-repo/06-validation-report.md +16 -0
- package/dist-assets/examples/docs-only-repo/README.md +26 -0
- package/dist-assets/examples/full-stack-checkout/00-CONTEXT.md +9 -0
- package/dist-assets/examples/full-stack-checkout/01-requirement.md +12 -0
- package/dist-assets/examples/full-stack-checkout/02-functional-spec.md +15 -0
- package/dist-assets/examples/full-stack-checkout/03-technical-plan.md +15 -0
- package/dist-assets/examples/full-stack-checkout/04-pr-breakdown.md +8 -0
- package/dist-assets/examples/full-stack-checkout/05-execution-handoff.md +14 -0
- package/dist-assets/examples/full-stack-checkout/06-validation-report.md +12 -0
- package/dist-assets/examples/healing-cycle/00-CONTEXT.md +15 -0
- package/dist-assets/examples/healing-cycle/01-broken-implementation.md +10 -0
- package/dist-assets/examples/healing-cycle/02-sage-fails.md +14 -0
- package/dist-assets/examples/healing-cycle/03-phoenix-diagnosis.md +17 -0
- package/dist-assets/examples/healing-cycle/04-phoenix-fix.md +18 -0
- package/dist-assets/examples/healing-cycle/05-sage-revalidation.md +12 -0
- package/dist-assets/examples/healing-cycle/06-orchestration-log.md +14 -0
- package/dist-assets/examples/infra-deploy/00-CONTEXT.md +9 -0
- package/dist-assets/examples/infra-deploy/01-operational-goal.md +12 -0
- package/dist-assets/examples/infra-deploy/02-architecture-specs.md +15 -0
- package/dist-assets/examples/infra-deploy/03-implementation-plan.md +14 -0
- package/dist-assets/examples/infra-deploy/04-step-breakdown.md +9 -0
- package/dist-assets/examples/infra-deploy/05-execution-handoff.md +13 -0
- package/dist-assets/examples/infra-deploy/06-operational-report.md +11 -0
- package/dist-assets/examples/multi-pr-release/00-CONTEXT.md +9 -0
- package/dist-assets/examples/multi-pr-release/01-requirement.md +13 -0
- package/dist-assets/examples/multi-pr-release/02-strategic-plan.md +13 -0
- package/dist-assets/examples/multi-pr-release/03-pr-breakdown.md +14 -0
- package/dist-assets/examples/multi-pr-release/04-release-plan.md +12 -0
- package/dist-assets/examples/multi-pr-release/05-orchestration-report.md +7 -0
- package/dist-assets/examples/nuxt-dashboard/01-requirement.md +81 -0
- package/dist-assets/examples/nuxt-dashboard/02-functional-spec.md +88 -0
- package/dist-assets/examples/nuxt-dashboard/03-technical-plan.md +76 -0
- package/dist-assets/examples/nuxt-dashboard/04-pr-breakdown.md +219 -0
- package/dist-assets/examples/nuxt-dashboard/05-execution-handoff.md +88 -0
- package/dist-assets/examples/nuxt-dashboard/06-validation-report.md +56 -0
- package/dist-assets/examples/nuxt-dashboard/07-orchestration-report.md +79 -0
- package/dist-assets/examples/nuxt-dashboard/README.md +52 -0
- package/dist-assets/examples/react-dashboard/01-requirement.md +84 -0
- package/dist-assets/examples/react-dashboard/02-functional-spec.md +88 -0
- package/dist-assets/examples/react-dashboard/03-technical-plan.md +76 -0
- package/dist-assets/examples/react-dashboard/04-pr-breakdown.md +218 -0
- package/dist-assets/examples/react-dashboard/05-execution-handoff.md +13 -0
- package/dist-assets/examples/react-dashboard/06-validation-report.md +12 -0
- package/dist-assets/examples/react-dashboard/07-orchestration-report.md +7 -0
- package/dist-assets/examples/react-dashboard/README.md +70 -0
- package/dist-assets/examples/refactoring-service/00-CONTEXT.md +9 -0
- package/dist-assets/examples/refactoring-service/01-debt-report.md +12 -0
- package/dist-assets/examples/refactoring-service/02-behavior-spec.md +11 -0
- package/dist-assets/examples/refactoring-service/03-technical-plan.md +13 -0
- package/dist-assets/examples/refactoring-service/04-pr-breakdown.md +9 -0
- package/dist-assets/examples/refactoring-service/05-execution-handoff.md +14 -0
- package/dist-assets/examples/refactoring-service/06-stability-report.md +12 -0
- package/dist-assets/examples/sdd-cycle/00-CONTEXT.md +12 -0
- package/dist-assets/examples/sdd-cycle/01-raw-request.md +13 -0
- package/dist-assets/examples/sdd-cycle/02-spec-creation.md +18 -0
- package/dist-assets/examples/sdd-cycle/03-spec-review.md +12 -0
- package/dist-assets/examples/sdd-cycle/04-technical-plan.md +16 -0
- package/dist-assets/examples/sdd-cycle/05-pr-breakdown.md +9 -0
- package/dist-assets/examples/sdd-cycle/06-spec-implement.md +13 -0
- package/dist-assets/examples/sdd-cycle/07-validation-against-spec.md +13 -0
- package/dist-assets/examples/wordpress-theme/01-requirement.md +29 -0
- package/dist-assets/examples/wordpress-theme/02-functional-spec.md +22 -0
- package/dist-assets/examples/wordpress-theme/03-technical-plan.md +22 -0
- package/dist-assets/examples/wordpress-theme/04-pr-breakdown.md +14 -0
- package/dist-assets/examples/wordpress-theme/05-execution-handoff.md +17 -0
- package/dist-assets/examples/wordpress-theme/06-validation-report.md +16 -0
- package/dist-assets/examples/wordpress-theme/README.md +32 -0
- package/{harness → dist-assets/harness}/handoffs/HANDOFF.template.md +2 -2
- package/{harness → dist-assets/harness}/workflows/agent-evaluation-checklist.md +5 -5
- package/{harness → dist-assets/harness}/workflows/implement-review-validate.md +24 -0
- package/{harness → dist-assets/harness}/workflows/multi-agent-handoff.md +4 -4
- package/{harness → dist-assets/harness}/workflows/planner-executor-workflow.md +5 -5
- package/{harness → dist-assets/harness}/workflows/requirement-to-pr.md +1 -1
- package/dist-assets/runbooks/agent-delegation-workflow.md +50 -0
- package/dist-assets/runbooks/apply-starter-to-real-project.md +45 -0
- package/dist-assets/runbooks/commands-cheatsheet.md +44 -0
- package/dist-assets/runbooks/how-to-use-skills.md +44 -0
- package/dist-assets/runbooks/private-spec-publication-safety.md +35 -0
- package/{runbooks → dist-assets/runbooks}/spec-driven-development.md +3 -6
- package/dist-assets/runbooks/tutorial-walkthroughs.md +23 -0
- package/dist-assets/runbooks/use-linear-for-operational-planning.md +45 -0
- package/dist-assets/runbooks/use-napkin-project-memory.md +33 -0
- package/dist-assets/skills/architecture/SKILL.md +166 -0
- package/dist-assets/skills/backend-development/SKILL.md +166 -0
- package/dist-assets/skills/deployment/SKILL.md +166 -0
- package/dist-assets/skills/design-principles/SKILL.md +166 -0
- package/dist-assets/skills/documentation/SKILL.md +171 -0
- package/dist-assets/skills/frontend-development/SKILL.md +225 -0
- package/dist-assets/skills/full-stack-development/SKILL.md +166 -0
- package/dist-assets/skills/optimize-tokens/SKILL.md +166 -0
- package/dist-assets/skills/pr-workflow/SKILL.md +166 -0
- package/dist-assets/skills/product-discovery/SKILL.md +166 -0
- package/dist-assets/skills/product-planning/SKILL.md +166 -0
- package/dist-assets/skills/project-memory/SKILL.md +166 -0
- package/dist-assets/skills/prompt-engineer/SKILL.md +166 -0
- package/dist-assets/skills/qa-workflow/SKILL.md +186 -0
- package/dist-assets/skills/refactoring/SKILL.md +166 -0
- package/dist-assets/skills/release-workflow/SKILL.md +166 -0
- package/dist-assets/skills/spec-driven-development/SKILL.md +166 -0
- package/dist-assets/skills/technical-leadership/SKILL.md +166 -0
- package/dist-assets/skills/ui-ux-design/SKILL.md +202 -0
- package/dist-assets/templates/.geminiignore.template +8 -0
- package/dist-assets/templates/CLAUDE.md.template +20 -0
- package/dist-assets/templates/CODEX.md.template +20 -0
- package/dist-assets/templates/GEMINI.md.template +20 -0
- package/dist-assets/templates/HANDOFF.template.md +45 -0
- package/dist-assets/templates/SPEC.template.md +38 -0
- package/dist-assets/templates/change-proposal.template.md +14 -0
- package/dist-assets/templates/owner-evidence/astra-implementation.json +10 -0
- package/dist-assets/templates/owner-evidence/phoenix-remediation.json +8 -0
- package/dist-assets/templates/owner-evidence/sage-revalidation.json +8 -0
- package/dist-assets/templates/owner-evidence/sage-validation.json +8 -0
- package/dist-assets/templates/specs/deep.md +48 -0
- package/dist-assets/templates/specs/standard.md +38 -0
- package/dist-assets/templates/specs/tiny.md +19 -0
- package/package.json +42 -47
- package/src/adapters/index.js +3 -0
- package/src/adapters/platforms/claude.js +126 -0
- package/src/adapters/platforms/codex.js +100 -0
- package/src/adapters/platforms/gemini.js +232 -0
- package/src/cli.js +96 -0
- package/src/commands/collect-evidence.js +61 -0
- package/src/commands/doctor.js +186 -0
- package/{packages/ai-workflow/src → src}/commands/init.js +119 -20
- package/src/commands/run.js +111 -0
- package/src/core/completion-contract.js +35 -0
- package/src/core/gates/branch-gate.js +113 -0
- package/src/core/handoff/handoff-engine.js +78 -0
- package/src/core/healing/cli-remediation-executor.js +151 -0
- package/src/core/healing/healer-engine.js +179 -0
- package/src/core/identity.js +43 -0
- package/{packages/ai-workflow/src → src}/core/install-plan.js +3 -3
- package/src/core/opencode-merge.js +149 -0
- package/{packages/ai-workflow/src → src}/core/package-assets.js +29 -10
- package/src/core/sdd/validator.js +67 -0
- package/src/core/statuses.js +29 -0
- package/src/core/symlink-layout.js +93 -0
- package/src/core/templates.js +218 -0
- package/src/core/validation/canonical-finalization.js +43 -0
- package/src/core/validation/evidence-collector.js +109 -0
- package/src/core/validation/quality-guard.js +243 -0
- package/src/core/workflow-profiles.js +107 -0
- package/.agents/napkin.md +0 -89
- package/.agents/skills/backend-implementer/SKILL.md +0 -490
- package/.agents/skills/build-and-validate/SKILL.md +0 -442
- package/.agents/skills/deploy-engineer/SKILL.md +0 -541
- package/.agents/skills/docs-writer/SKILL.md +0 -430
- package/.agents/skills/frontend-implementer/SKILL.md +0 -488
- package/.agents/skills/interface-design/SKILL.md +0 -428
- package/.agents/skills/interface-design/references/critique.md +0 -67
- package/.agents/skills/interface-design/references/example.md +0 -86
- package/.agents/skills/interface-design/references/principles.md +0 -235
- package/.agents/skills/interface-design/references/validation.md +0 -48
- package/.agents/skills/minimal-context/SKILL.md +0 -177
- package/.agents/skills/napkin/SKILL.md +0 -84
- package/.agents/skills/opencode-agent-design/SKILL.md +0 -77
- package/.agents/skills/playwright-cli/SKILL.md +0 -62
- package/.agents/skills/pr-orchestrator/SKILL.md +0 -366
- package/.agents/skills/product-manager/SKILL.md +0 -519
- package/.agents/skills/seo-audit/SKILL.md +0 -176
- package/.agents/skills/stack-variant-creator/SKILL.md +0 -265
- package/.agents/skills/tech-lead/SKILL.md +0 -453
- package/.agents/skills/tester/SKILL.md +0 -399
- package/.agents/skills/token-economy/SKILL.md +0 -137
- package/.agents/skills/vue-nuxt/SKILL.md +0 -102
- package/.agents/skills/wordpress-engineer/SKILL.md +0 -75
- package/.codex/prompts/README.md +0 -44
- package/.codex/prompts/autopilot.md +0 -50
- package/.codex/prompts/deploy.md +0 -33
- package/.codex/prompts/execute-selected-pr.md +0 -35
- package/.codex/prompts/fix-issue.md +0 -34
- package/.codex/prompts/minimal-context-mode.md +0 -55
- package/.codex/prompts/orchestrate-next.md +0 -33
- package/.codex/prompts/plan-from-requirement.md +0 -37
- package/.codex/prompts/review-implementation.md +0 -33
- package/.codex/prompts/roadmap-audit.md +0 -22
- package/.codex/prompts/specs/create-spec-from-requirement.md +0 -26
- package/.codex/prompts/specs/review-spec.md +0 -29
- package/.codex/prompts/specs/spec-to-pr-breakdown.md +0 -23
- package/.codex/prompts/specs/spec-to-technical-plan.md +0 -28
- package/.codex/prompts/start-project.md +0 -29
- package/.codex/prompts/token-economy-mode.md +0 -48
- package/.codex/prompts/validate-work.md +0 -28
- package/checklists/change-spec-readiness-checklist.md +0 -34
- package/docs/full-documentation.md +0 -661
- package/docs/setup-codex-opencode.md +0 -313
- package/harness/README.md +0 -106
- package/opencode/README.md +0 -84
- package/opencode/agents/README.md +0 -113
- package/opencode/agents/atlas.md +0 -127
- package/opencode/agents/discovery.md +0 -61
- package/opencode/agents/fixer.md +0 -51
- package/opencode/agents/implementer.md +0 -61
- package/opencode/agents/orchestrator.md +0 -145
- package/opencode/agents/planner.md +0 -60
- package/opencode/agents/prompt-engineer.md +0 -50
- package/opencode/agents/release-manager.md +0 -50
- package/opencode/agents/reviewer.md +0 -51
- package/opencode/agents/spec-engineer.md +0 -85
- package/opencode/agents/validator.md +0 -50
- package/opencode/agents/wordpress-engineer.md +0 -49
- package/opencode/commands/README.md +0 -48
- package/opencode/commands/autopilot.md +0 -50
- package/opencode/commands/deploy.md +0 -35
- package/opencode/commands/execute.md +0 -47
- package/opencode/commands/orchestrate.md +0 -37
- package/opencode/commands/plan.md +0 -39
- package/opencode/commands/review.md +0 -33
- package/opencode/commands/roadmap-audit.md +0 -30
- package/opencode/commands/ship.md +0 -48
- package/opencode/commands/specs/create-spec-from-request.md +0 -27
- package/opencode/commands/specs/create-spec-from-requirement.md +0 -25
- package/opencode/commands/specs/review-spec.md +0 -26
- package/opencode/commands/specs/spec-to-pr-breakdown.md +0 -19
- package/opencode/commands/specs/spec-to-tasks.md +0 -26
- package/opencode/commands/specs/spec-to-technical-plan.md +0 -27
- package/opencode/commands/start.md +0 -45
- package/opencode/commands/token-economy.md +0 -29
- package/opencode/commands/validate.md +0 -33
- package/opencode.jsonc +0 -235
- package/packages/ai-workflow/README.md +0 -82
- package/packages/ai-workflow/src/cli.js +0 -70
- package/packages/ai-workflow/src/commands/codex.js +0 -37
- package/packages/ai-workflow/src/commands/doctor.js +0 -168
- package/packages/ai-workflow/src/commands/guide.js +0 -194
- package/packages/ai-workflow/src/core/opencode-merge.js +0 -172
- package/packages/ai-workflow/src/core/symlink-layout.js +0 -54
- package/packages/ai-workflow/src/core/templates.js +0 -276
- package/runbooks/agent-delegation-workflow.md +0 -111
- package/runbooks/apply-starter-to-real-project.md +0 -445
- package/runbooks/commands-cheatsheet.md +0 -71
- package/runbooks/how-to-use-skills.md +0 -713
- package/runbooks/quick-start-guide.md +0 -213
- package/runbooks/tutorial-walkthroughs.md +0 -416
- package/runbooks/use-linear-for-operational-planning.md +0 -185
- package/runbooks/use-napkin-project-memory.md +0 -77
- package/templates/AGENTS.template.md +0 -397
- package/templates/DESIGN.template.md +0 -484
- package/templates/PR-PLAN.template.md +0 -172
- package/templates/README.template.md +0 -293
- package/templates/REQUIREMENT.template.md +0 -165
- package/templates/SPEC.template.md +0 -397
- package/templates/TECH-PLAN.template.md +0 -244
- package/templates/change-proposal.template.md +0 -97
- /package/{checklists/spec-readiness-checklist.md → dist-assets/docs/policies/SPEC_READINESS.md} +0 -0
- /package/{prompts → dist-assets/prompts}/00-bootstrap-project.md +0 -0
- /package/{prompts → dist-assets/prompts}/01-create-requirement.md +0 -0
- /package/{prompts → dist-assets/prompts}/02-create-spec.md +0 -0
- /package/{prompts → dist-assets/prompts}/03-create-tech-plan.md +0 -0
- /package/{prompts → dist-assets/prompts}/04-breakdown-prs.md +0 -0
- /package/{prompts → dist-assets/prompts}/05-implement-pr.md +0 -0
- /package/{prompts → dist-assets/prompts}/06-review-and-fix.md +0 -0
- /package/{prompts → dist-assets/prompts}/07-apply-design.md +0 -0
- /package/{prompts → dist-assets/prompts}/08-validate.md +0 -0
- /package/{prompts → dist-assets/prompts}/09-deploy.md +0 -0
- /package/{prompts → dist-assets/prompts}/commands/implement.md +0 -0
- /package/{prompts → dist-assets/prompts}/commands/requirement.md +0 -0
- /package/{prompts → dist-assets/prompts}/commands/spec.md +0 -0
- /package/{prompts → dist-assets/prompts}/commands/tech-plan.md +0 -0
- /package/{prompts → dist-assets/prompts}/commands/validate.md +0 -0
- /package/{runbooks → dist-assets/runbooks}/branch-cleanup.md +0 -0
- /package/{runbooks → dist-assets/runbooks}/deploy-checklist.md +0 -0
- /package/{runbooks → dist-assets/runbooks}/publication-readiness-checklist.md +0 -0
- /package/{runbooks → dist-assets/runbooks}/publish-package-checklist.md +0 -0
- /package/{runbooks → dist-assets/runbooks}/team-governance-pr-readiness.md +0 -0
- /package/{runbooks → dist-assets/runbooks}/validate-starter-in-real-project.md +0 -0
- /package/{runbooks → dist-assets/runbooks}/validation-checklist.md +0 -0
- /package/{schemas → dist-assets/schemas}/README.md +0 -0
- /package/{schemas → dist-assets/schemas}/functional-spec.schema.json +0 -0
- /package/{schemas → dist-assets/schemas}/handoff.schema.json +0 -0
- /package/{schemas → dist-assets/schemas}/pr-breakdown.schema.json +0 -0
- /package/{schemas → dist-assets/schemas}/requirement.schema.json +0 -0
- /package/{schemas → dist-assets/schemas}/technical-plan.schema.json +0 -0
- /package/{schemas → dist-assets/schemas}/validation-report.schema.json +0 -0
- /package/{packages/ai-workflow/src → src}/core/backup.js +0 -0
- /package/{packages/ai-workflow/src → src}/core/filesystem.js +0 -0
|
@@ -1,265 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: stack-variant-creator
|
|
3
|
-
description: Use when creating a workflow variant for a specific tech stack (React, Laravel, Go, Python, etc.) based on the generic ai-workflow core.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
> Token economy active: keep output compact, context minimal. Reference: `token-economy` + `minimal-context` skills.
|
|
7
|
-
|
|
8
|
-
# Stack Variant Creator Skill
|
|
9
|
-
|
|
10
|
-
## Purpose
|
|
11
|
-
|
|
12
|
-
Create focused workflow variants for specific tech stacks while preserving the generic core of ai-workflow.
|
|
13
|
-
|
|
14
|
-
A variant adapts the generic skills, prompts, runbooks, and templates to the patterns, conventions, and validation commands of a particular stack — without duplicating or modifying the generic core.
|
|
15
|
-
|
|
16
|
-
## Use when
|
|
17
|
-
|
|
18
|
-
- A user asks to create a variant for a new stack (React, Laravel, Go, Python, etc.).
|
|
19
|
-
- A stack-specific workflow pilot is needed to validate adoption.
|
|
20
|
-
- A new skill needs to be created that depends on stack conventions.
|
|
21
|
-
- A runbook needs to be adapted for a specific stack environment.
|
|
22
|
-
|
|
23
|
-
## Scope
|
|
24
|
-
|
|
25
|
-
**In scope**:
|
|
26
|
-
|
|
27
|
-
- create `.agents/skills/<stack-name>/SKILL.md` with stack-specific guidance;
|
|
28
|
-
- create `examples/<stack-name>/` with workflow demonstration files;
|
|
29
|
-
- create `runbooks/<stack-name>-setup.md` for stack-specific bootstrap;
|
|
30
|
-
- add stack-specific validation commands to existing runbooks;
|
|
31
|
-
- create `prompts/commands/<stack-name>.md` for stack-specific command entrypoints.
|
|
32
|
-
|
|
33
|
-
**Out of scope**:
|
|
34
|
-
|
|
35
|
-
- modifying generic skills (frontend-implementer, backend-implementer, etc.);
|
|
36
|
-
- changing core workflow prompts (00-bootstrap to 09-deploy);
|
|
37
|
-
- generating application boilerplate or starter code;
|
|
38
|
-
- adding stack-specific assumptions to `AGENTS.md` or `README.md`.
|
|
39
|
-
|
|
40
|
-
## Workflow
|
|
41
|
-
|
|
42
|
-
### Step 1 — Define variant scope
|
|
43
|
-
|
|
44
|
-
Before creating anything, define:
|
|
45
|
-
|
|
46
|
-
- target stack name (e.g., `react-dashboard`, `laravel-api`);
|
|
47
|
-
- what the variant covers (skills, examples, runbooks, commands);
|
|
48
|
-
- what the generic core must not change;
|
|
49
|
-
- who the audience is (developers familiar with this stack);
|
|
50
|
-
- what existing variant to use as reference pattern.
|
|
51
|
-
|
|
52
|
-
Reference variants:
|
|
53
|
-
|
|
54
|
-
```txt
|
|
55
|
-
examples/nuxt-dashboard/ — frontend stack (Nuxt/Vue)
|
|
56
|
-
examples/wordpress-theme/ — PHP stack (WordPress/PHP 7)
|
|
57
|
-
examples/docs-only-repo/ — non-code stack (documentation)
|
|
58
|
-
```
|
|
59
|
-
|
|
60
|
-
### Step 2 — Create skill directory
|
|
61
|
-
|
|
62
|
-
Create the skill folder:
|
|
63
|
-
|
|
64
|
-
```txt
|
|
65
|
-
.agents/skills/<stack-name>/
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
Reference the existing skill structure:
|
|
69
|
-
|
|
70
|
-
```txt
|
|
71
|
-
.agents/skills/vue-nuxt/SKILL.md
|
|
72
|
-
.agents/skills/wordpress-engineer/SKILL.md
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
### Step 3 — Create the stack-specific SKILL.md
|
|
76
|
-
|
|
77
|
-
The skill must include:
|
|
78
|
-
|
|
79
|
-
```md
|
|
80
|
-
---
|
|
81
|
-
name: <stack-name>
|
|
82
|
-
description: Use when working on <stack description> with <key convention or pattern>.
|
|
83
|
-
---
|
|
84
|
-
|
|
85
|
-
# <Stack Name> Skill
|
|
86
|
-
|
|
87
|
-
## Purpose
|
|
88
|
-
|
|
89
|
-
[1-2 sentences describing the role]
|
|
90
|
-
|
|
91
|
-
## When to use
|
|
92
|
-
|
|
93
|
-
Use this skill when:
|
|
94
|
-
- [specific use case 1]
|
|
95
|
-
- [specific use case 2]
|
|
96
|
-
|
|
97
|
-
## Required context
|
|
98
|
-
|
|
99
|
-
- Working directory contains a <stack> project
|
|
100
|
-
- [specific file patterns or conventions]
|
|
101
|
-
- [specific validation commands]
|
|
102
|
-
|
|
103
|
-
## Core responsibilities
|
|
104
|
-
|
|
105
|
-
1. [responsibility 1]
|
|
106
|
-
2. [responsibility 2]
|
|
107
|
-
|
|
108
|
-
## Stack conventions
|
|
109
|
-
|
|
110
|
-
### Folder structure
|
|
111
|
-
|
|
112
|
-
```txt
|
|
113
|
-
[typical folder structure for this stack]
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
### Key files
|
|
117
|
-
|
|
118
|
-
| File | Purpose |
|
|
119
|
-
| --- | --- |
|
|
120
|
-
| `file` | description |
|
|
121
|
-
|
|
122
|
-
### Validation commands
|
|
123
|
-
|
|
124
|
-
| Command | What it checks |
|
|
125
|
-
| --- | --- |
|
|
126
|
-
| `npm run build` | production build |
|
|
127
|
-
| `npm run lint` | code style |
|
|
128
|
-
| `npm test` | unit tests |
|
|
129
|
-
|
|
130
|
-
## Constraints
|
|
131
|
-
|
|
132
|
-
- Do not modify the generic core of ai-workflow
|
|
133
|
-
- Follow existing <stack> patterns and conventions
|
|
134
|
-
- Validate before moving forward
|
|
135
|
-
- Preserve existing behavior unless explicitly requested
|
|
136
|
-
|
|
137
|
-
## Expected output
|
|
138
|
-
|
|
139
|
-
- Stack-specific implementation notes
|
|
140
|
-
- Changed files list
|
|
141
|
-
- Validation evidence
|
|
142
|
-
- Final status: Proceed | Needs clarification | Blocked
|
|
143
|
-
|
|
144
|
-
## Stop conditions
|
|
145
|
-
|
|
146
|
-
- Stop when required context is missing
|
|
147
|
-
- Stop when implementation would modify the generic core
|
|
148
|
-
- Stop when validation cannot be executed
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
### Step 4 — Create example workflow (optional)
|
|
152
|
-
|
|
153
|
-
If the variant needs a demonstration:
|
|
154
|
-
|
|
155
|
-
```txt
|
|
156
|
-
examples/<stack-name>/
|
|
157
|
-
├── 01-requirement.md
|
|
158
|
-
├── 02-functional-spec.md
|
|
159
|
-
├── 03-technical-plan.md
|
|
160
|
-
├── 04-pr-breakdown.md
|
|
161
|
-
├── 05-execution-handoff.md (optional)
|
|
162
|
-
└── README.md
|
|
163
|
-
```
|
|
164
|
-
|
|
165
|
-
Reference: `examples/nuxt-dashboard/README.md`
|
|
166
|
-
|
|
167
|
-
### Step 5 — Validate
|
|
168
|
-
|
|
169
|
-
Run these checks:
|
|
170
|
-
|
|
171
|
-
```bash
|
|
172
|
-
npm run validate:md
|
|
173
|
-
npm run validate:json # if JSON added
|
|
174
|
-
npm run validate:structure
|
|
175
|
-
```
|
|
176
|
-
|
|
177
|
-
Check that:
|
|
178
|
-
|
|
179
|
-
- no generic core file was modified;
|
|
180
|
-
- YAML frontmatter is valid;
|
|
181
|
-
- Markdown formatting is safe;
|
|
182
|
-
- file paths referenced in the skill exist.
|
|
183
|
-
|
|
184
|
-
### Step 6 — Document the variant
|
|
185
|
-
|
|
186
|
-
Update `README.md` only to add the new variant to the examples list:
|
|
187
|
-
|
|
188
|
-
```md
|
|
189
|
-
### Available Examples
|
|
190
|
-
|
|
191
|
-
```txt
|
|
192
|
-
examples/nuxt-dashboard/ — Nuxt dashboard with shell, auth, CRUD, and validation
|
|
193
|
-
examples/wordpress-theme/ — WordPress theme with PHP 7, hooks, and custom post types
|
|
194
|
-
examples/docs-only-repo/ — Documentation-only repository with Markdown validation
|
|
195
|
-
examples/<stack-name>/ — [stack description]
|
|
196
|
-
```
|
|
197
|
-
```
|
|
198
|
-
|
|
199
|
-
Do not add stack-specific assumptions to generic sections.
|
|
200
|
-
|
|
201
|
-
## Constraints
|
|
202
|
-
|
|
203
|
-
- Do not conflict with `AGENTS.md` hard constraints.
|
|
204
|
-
- Do not modify generic skills, prompts, or core workflow files.
|
|
205
|
-
- Do not generate application boilerplate code.
|
|
206
|
-
- Do not invent stack conventions; follow established patterns.
|
|
207
|
-
- Do not claim validation passed without evidence.
|
|
208
|
-
- Keep variants reviewable and independently useful.
|
|
209
|
-
|
|
210
|
-
## Validation checklist
|
|
211
|
-
|
|
212
|
-
- Stack-specific skill has valid YAML frontmatter.
|
|
213
|
-
- Description triggers correctly for the target stack.
|
|
214
|
-
- Folder structure follows existing skill patterns.
|
|
215
|
-
- No generic core files were modified.
|
|
216
|
-
- Markdown formatting is valid.
|
|
217
|
-
- Validation commands are realistic and testable.
|
|
218
|
-
- Example workflow (if created) follows existing patterns.
|
|
219
|
-
|
|
220
|
-
## Expected output
|
|
221
|
-
|
|
222
|
-
- `.agents/skills/<stack-name>/SKILL.md` created
|
|
223
|
-
- `examples/<stack-name>/` created (if applicable)
|
|
224
|
-
- Validation evidence from `npm run validate` commands
|
|
225
|
-
- Final status: `Approved`, `Approved with notes`, `Changes requested`, or `Blocked`
|
|
226
|
-
|
|
227
|
-
## Stop conditions
|
|
228
|
-
|
|
229
|
-
- Stop when required context (target stack, conventions, commands) is missing.
|
|
230
|
-
- Stop when the variant would require modifying the generic core.
|
|
231
|
-
- Stop when the skill description is too generic to trigger correctly.
|
|
232
|
-
- Stop when validation evidence cannot be produced.
|
|
233
|
-
|
|
234
|
-
## Example: Creating a React Dashboard variant
|
|
235
|
-
|
|
236
|
-
```txt
|
|
237
|
-
# Step 1: Define scope
|
|
238
|
-
- Stack: React Dashboard
|
|
239
|
-
- Coverage: skill + example
|
|
240
|
-
- Generic core: unchanged
|
|
241
|
-
- Audience: React/Next.js developers
|
|
242
|
-
|
|
243
|
-
# Step 2: Create directory
|
|
244
|
-
.agents/skills/react-dashboard/
|
|
245
|
-
|
|
246
|
-
# Step 3: Create SKILL.md
|
|
247
|
-
.agents/skills/react-dashboard/SKILL.md
|
|
248
|
-
|
|
249
|
-
# Step 4: Create example
|
|
250
|
-
examples/react-dashboard/
|
|
251
|
-
├── 01-requirement.md
|
|
252
|
-
├── 02-functional-spec.md
|
|
253
|
-
├── 03-technical-plan.md
|
|
254
|
-
├── 04-pr-breakdown.md
|
|
255
|
-
└── README.md
|
|
256
|
-
|
|
257
|
-
# Step 5: Validate
|
|
258
|
-
npm run validate
|
|
259
|
-
|
|
260
|
-
# Step 6: Update README examples list only
|
|
261
|
-
```
|
|
262
|
-
|
|
263
|
-
## Final instruction
|
|
264
|
-
|
|
265
|
-
Create small, reviewable variants. Do not create a full application inside the starter. The goal is to make the generic workflow faster to adopt for a specific stack, not to replace the stack's official starter.
|
|
@@ -1,453 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: tech-lead
|
|
3
|
-
description: Use when making technical decisions, reviewing architecture, identifying trade-offs, or splitting software work into safe incremental steps.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
> Token economy active: keep output compact, context minimal. Reference: `token-economy` + `minimal-context` skills.
|
|
7
|
-
|
|
8
|
-
# Tech Lead Skill
|
|
9
|
-
|
|
10
|
-
## Purpose
|
|
11
|
-
|
|
12
|
-
Use this skill when Codex needs to transform requirements or specifications into a safe technical direction.
|
|
13
|
-
|
|
14
|
-
The tech lead role is responsible for technical judgment, architecture boundaries, implementation strategy, risk control, trade-off analysis, and pull request planning.
|
|
15
|
-
|
|
16
|
-
This skill does not focus on writing all code directly. It focuses on choosing the safest technical path before implementation starts.
|
|
17
|
-
|
|
18
|
-
## When to use this skill
|
|
19
|
-
|
|
20
|
-
Use this skill when the task involves:
|
|
21
|
-
|
|
22
|
-
- creating a technical plan;
|
|
23
|
-
- reviewing a specification for implementation readiness;
|
|
24
|
-
- choosing an architecture approach;
|
|
25
|
-
- breaking work into pull requests;
|
|
26
|
-
- identifying technical risks;
|
|
27
|
-
- defining validation strategy;
|
|
28
|
-
- reviewing implementation scope;
|
|
29
|
-
- deciding whether a refactor is justified;
|
|
30
|
-
- protecting existing behavior from regression.
|
|
31
|
-
|
|
32
|
-
## Core responsibilities
|
|
33
|
-
|
|
34
|
-
When acting as tech lead, Codex must:
|
|
35
|
-
|
|
36
|
-
1. understand the requirement or specification;
|
|
37
|
-
2. identify the current project structure and existing patterns;
|
|
38
|
-
3. avoid inventing architecture when existing patterns are sufficient;
|
|
39
|
-
4. define a safe implementation strategy;
|
|
40
|
-
5. identify files or areas likely to change;
|
|
41
|
-
6. identify risks, trade-offs, and constraints;
|
|
42
|
-
7. split work into small pull requests;
|
|
43
|
-
8. define validation steps;
|
|
44
|
-
9. protect existing behavior;
|
|
45
|
-
10. document assumptions and open technical questions;
|
|
46
|
-
11. recommend whether implementation should proceed.
|
|
47
|
-
|
|
48
|
-
## Technical leadership principles
|
|
49
|
-
|
|
50
|
-
### 1. Existing patterns first
|
|
51
|
-
|
|
52
|
-
Prefer the project’s existing architecture, naming, folder structure, and conventions.
|
|
53
|
-
|
|
54
|
-
Do not introduce new patterns unless there is a clear reason.
|
|
55
|
-
|
|
56
|
-
A new abstraction is only justified when it reduces real complexity, duplication, risk, or maintenance cost.
|
|
57
|
-
|
|
58
|
-
### 2. Small safe steps
|
|
59
|
-
|
|
60
|
-
Prefer incremental changes.
|
|
61
|
-
|
|
62
|
-
A technical plan should make the next step reviewable and reversible.
|
|
63
|
-
|
|
64
|
-
Avoid large changes that combine:
|
|
65
|
-
|
|
66
|
-
- architecture changes;
|
|
67
|
-
- feature work;
|
|
68
|
-
- refactoring;
|
|
69
|
-
- dependency upgrades;
|
|
70
|
-
- formatting-only changes;
|
|
71
|
-
- unrelated cleanup.
|
|
72
|
-
|
|
73
|
-
### 3. No regression
|
|
74
|
-
|
|
75
|
-
Existing behavior must be preserved unless the requirement explicitly asks for a behavior change.
|
|
76
|
-
|
|
77
|
-
If behavior must change, state:
|
|
78
|
-
|
|
79
|
-
- what changes;
|
|
80
|
-
- why it changes;
|
|
81
|
-
- where it changes;
|
|
82
|
-
- how it will be validated.
|
|
83
|
-
|
|
84
|
-
### 4. Trade-offs must be explicit
|
|
85
|
-
|
|
86
|
-
Every technical approach has a cost.
|
|
87
|
-
|
|
88
|
-
When proposing a solution, include trade-offs such as:
|
|
89
|
-
|
|
90
|
-
- speed vs maintainability;
|
|
91
|
-
- simplicity vs extensibility;
|
|
92
|
-
- local fix vs architectural change;
|
|
93
|
-
- short-term patch vs long-term refactor;
|
|
94
|
-
- strict typing vs development speed;
|
|
95
|
-
- test coverage vs delivery time.
|
|
96
|
-
|
|
97
|
-
### 5. Validation before confidence
|
|
98
|
-
|
|
99
|
-
Do not claim that a plan is safe without validation strategy.
|
|
100
|
-
|
|
101
|
-
A good technical plan defines how the change will be checked.
|
|
102
|
-
|
|
103
|
-
## Technical plan structure
|
|
104
|
-
|
|
105
|
-
When creating a technical plan, use this structure:
|
|
106
|
-
|
|
107
|
-
```md
|
|
108
|
-
# Technical Plan
|
|
109
|
-
|
|
110
|
-
## Summary
|
|
111
|
-
|
|
112
|
-
Short explanation of the proposed technical direction.
|
|
113
|
-
|
|
114
|
-
## Inputs
|
|
115
|
-
|
|
116
|
-
- Requirement:
|
|
117
|
-
- Specification:
|
|
118
|
-
- Relevant constraints:
|
|
119
|
-
|
|
120
|
-
## Current state
|
|
121
|
-
|
|
122
|
-
Brief description of the current implementation or project structure.
|
|
123
|
-
|
|
124
|
-
## Proposed approach
|
|
125
|
-
|
|
126
|
-
Explain the implementation strategy.
|
|
127
|
-
|
|
128
|
-
## Files likely to change
|
|
129
|
-
|
|
130
|
-
- `path/to/file` — expected change
|
|
131
|
-
|
|
132
|
-
## Files that should not change
|
|
133
|
-
|
|
134
|
-
- `path/to/file` — reason
|
|
135
|
-
|
|
136
|
-
## Data flow / control flow
|
|
137
|
-
|
|
138
|
-
Explain how the feature or change should work technically.
|
|
139
|
-
|
|
140
|
-
## Risks and trade-offs
|
|
141
|
-
|
|
142
|
-
| Risk / Trade-off | Impact | Mitigation |
|
|
143
|
-
| ---------------- | -------- | ------------ |
|
|
144
|
-
| Risk 1 | Impact 1 | Mitigation 1 |
|
|
145
|
-
|
|
146
|
-
## Pull request breakdown
|
|
147
|
-
|
|
148
|
-
### PR 1 — Title
|
|
149
|
-
|
|
150
|
-
Scope:
|
|
151
|
-
|
|
152
|
-
- Item 1
|
|
153
|
-
- Item 2
|
|
154
|
-
|
|
155
|
-
Validation:
|
|
156
|
-
|
|
157
|
-
- Check 1
|
|
158
|
-
- Check 2
|
|
159
|
-
|
|
160
|
-
### PR 2 — Title
|
|
161
|
-
|
|
162
|
-
Scope:
|
|
163
|
-
|
|
164
|
-
- Item 1
|
|
165
|
-
- Item 2
|
|
166
|
-
|
|
167
|
-
Validation:
|
|
168
|
-
|
|
169
|
-
- Check 1
|
|
170
|
-
- Check 2
|
|
171
|
-
|
|
172
|
-
## Validation strategy
|
|
173
|
-
|
|
174
|
-
### Automated checks
|
|
175
|
-
|
|
176
|
-
- `command`
|
|
177
|
-
|
|
178
|
-
### Manual checks
|
|
179
|
-
|
|
180
|
-
- Step 1
|
|
181
|
-
- Step 2
|
|
182
|
-
|
|
183
|
-
## Open technical questions
|
|
184
|
-
|
|
185
|
-
- Question 1
|
|
186
|
-
|
|
187
|
-
## Final recommendation
|
|
188
|
-
|
|
189
|
-
Proceed | Needs clarification | Split first | Not recommended
|
|
190
|
-
```
|
|
191
|
-
|
|
192
|
-
## Architecture review checklist
|
|
193
|
-
|
|
194
|
-
Use this checklist when reviewing or creating a technical plan.
|
|
195
|
-
|
|
196
|
-
### Scope
|
|
197
|
-
|
|
198
|
-
- Is the problem technically understood?
|
|
199
|
-
- Is the scope small enough?
|
|
200
|
-
- Are unrelated changes excluded?
|
|
201
|
-
- Are behavior changes explicit?
|
|
202
|
-
- Is refactoring separated from feature work?
|
|
203
|
-
|
|
204
|
-
### Architecture
|
|
205
|
-
|
|
206
|
-
- Does the plan follow existing patterns?
|
|
207
|
-
- Is the proposed abstraction necessary?
|
|
208
|
-
- Are responsibilities separated?
|
|
209
|
-
- Is the data flow understandable?
|
|
210
|
-
- Are dependencies pointing in the right direction?
|
|
211
|
-
- Is the solution over-engineered?
|
|
212
|
-
- Is the solution under-engineered?
|
|
213
|
-
|
|
214
|
-
### Maintainability
|
|
215
|
-
|
|
216
|
-
- Is the change easy to review?
|
|
217
|
-
- Is the change easy to test?
|
|
218
|
-
- Is the change easy to rollback?
|
|
219
|
-
- Are names and boundaries clear?
|
|
220
|
-
- Is duplication acceptable or should it be removed?
|
|
221
|
-
- Are there hidden coupling risks?
|
|
222
|
-
|
|
223
|
-
### Testing and validation
|
|
224
|
-
|
|
225
|
-
- Are acceptance criteria covered?
|
|
226
|
-
- Are automated tests planned when relevant?
|
|
227
|
-
- Are manual checks defined?
|
|
228
|
-
- Is build validation included?
|
|
229
|
-
- Are regression risks listed?
|
|
230
|
-
- Are untested areas visible?
|
|
231
|
-
|
|
232
|
-
### Security and reliability
|
|
233
|
-
|
|
234
|
-
Use this section when relevant.
|
|
235
|
-
|
|
236
|
-
- Are authentication and authorization preserved?
|
|
237
|
-
- Are secrets protected?
|
|
238
|
-
- Is user input handled safely?
|
|
239
|
-
- Are failure modes defined?
|
|
240
|
-
- Are external service failures considered?
|
|
241
|
-
- Is there a rollback or fallback path?
|
|
242
|
-
|
|
243
|
-
### Performance
|
|
244
|
-
|
|
245
|
-
Use this section when relevant.
|
|
246
|
-
|
|
247
|
-
- Does the plan add unnecessary work on render or request?
|
|
248
|
-
- Does it increase network calls?
|
|
249
|
-
- Does it affect bundle size?
|
|
250
|
-
- Does it introduce expensive loops?
|
|
251
|
-
- Does it affect caching?
|
|
252
|
-
- Is the performance risk acceptable?
|
|
253
|
-
|
|
254
|
-
## PR breakdown rules
|
|
255
|
-
|
|
256
|
-
When breaking work into PRs:
|
|
257
|
-
|
|
258
|
-
- one PR should have one primary purpose;
|
|
259
|
-
- validation should be possible per PR;
|
|
260
|
-
- refactors should be isolated when possible;
|
|
261
|
-
- dependency upgrades should be isolated;
|
|
262
|
-
- tests should be close to the behavior they validate;
|
|
263
|
-
- documentation should be updated in the same PR only when it documents that PR’s behavior;
|
|
264
|
-
- avoid PRs that are too large to review safely.
|
|
265
|
-
|
|
266
|
-
A good PR breakdown should allow the project to stay working after each PR.
|
|
267
|
-
|
|
268
|
-
## Decision model
|
|
269
|
-
|
|
270
|
-
Use the following decision labels.
|
|
271
|
-
|
|
272
|
-
### Proceed
|
|
273
|
-
|
|
274
|
-
Use when the requirement or spec is clear enough, the technical path is safe, and implementation can start.
|
|
275
|
-
|
|
276
|
-
### Needs clarification
|
|
277
|
-
|
|
278
|
-
Use when important technical or product information is missing.
|
|
279
|
-
|
|
280
|
-
### Split first
|
|
281
|
-
|
|
282
|
-
Use when the work is too broad and should be broken down before implementation.
|
|
283
|
-
|
|
284
|
-
### Not recommended
|
|
285
|
-
|
|
286
|
-
Use when the proposed approach creates more risk than value, conflicts with existing architecture, or solves the wrong problem.
|
|
287
|
-
|
|
288
|
-
## Severity model
|
|
289
|
-
|
|
290
|
-
Use severity when reviewing technical risks.
|
|
291
|
-
|
|
292
|
-
### High
|
|
293
|
-
|
|
294
|
-
Use `High` when the issue can cause:
|
|
295
|
-
|
|
296
|
-
- severe regression;
|
|
297
|
-
- broken critical flow;
|
|
298
|
-
- security vulnerability;
|
|
299
|
-
- deployment failure;
|
|
300
|
-
- data loss;
|
|
301
|
-
- architecture conflict;
|
|
302
|
-
- unreviewable PR size;
|
|
303
|
-
- missing validation for critical behavior.
|
|
304
|
-
|
|
305
|
-
### Medium
|
|
306
|
-
|
|
307
|
-
Use `Medium` when the issue can cause:
|
|
308
|
-
|
|
309
|
-
- maintainability risk;
|
|
310
|
-
- unclear responsibilities;
|
|
311
|
-
- fragile abstraction;
|
|
312
|
-
- incomplete validation;
|
|
313
|
-
- unnecessary complexity;
|
|
314
|
-
- inconsistent project pattern;
|
|
315
|
-
- unclear rollback path.
|
|
316
|
-
|
|
317
|
-
### Low
|
|
318
|
-
|
|
319
|
-
Use `Low` when the issue is related to:
|
|
320
|
-
|
|
321
|
-
- minor naming issue;
|
|
322
|
-
- small documentation gap;
|
|
323
|
-
- non-blocking cleanup;
|
|
324
|
-
- optional simplification;
|
|
325
|
-
- minor consistency improvement.
|
|
326
|
-
|
|
327
|
-
## Review output format
|
|
328
|
-
|
|
329
|
-
When reviewing a technical plan, Codex should respond using this structure:
|
|
330
|
-
|
|
331
|
-
```md
|
|
332
|
-
# Tech Lead Review
|
|
333
|
-
|
|
334
|
-
## Summary
|
|
335
|
-
|
|
336
|
-
Short conclusion.
|
|
337
|
-
|
|
338
|
-
## Status
|
|
339
|
-
|
|
340
|
-
Proceed | Needs clarification | Split first | Not recommended
|
|
341
|
-
|
|
342
|
-
## What is good
|
|
343
|
-
|
|
344
|
-
- Item 1
|
|
345
|
-
- Item 2
|
|
346
|
-
|
|
347
|
-
## What is fragile
|
|
348
|
-
|
|
349
|
-
- Item 1
|
|
350
|
-
- Item 2
|
|
351
|
-
|
|
352
|
-
## What is excessive
|
|
353
|
-
|
|
354
|
-
- Item 1
|
|
355
|
-
- Item 2
|
|
356
|
-
|
|
357
|
-
## Risks
|
|
358
|
-
|
|
359
|
-
### Risk 1
|
|
360
|
-
|
|
361
|
-
Severity: High | Medium | Low
|
|
362
|
-
|
|
363
|
-
Description:
|
|
364
|
-
Explain the risk.
|
|
365
|
-
|
|
366
|
-
Impact:
|
|
367
|
-
Explain why it matters.
|
|
368
|
-
|
|
369
|
-
Mitigation:
|
|
370
|
-
Explain the smallest safe mitigation.
|
|
371
|
-
|
|
372
|
-
## Missing information
|
|
373
|
-
|
|
374
|
-
- Item 1
|
|
375
|
-
- Item 2
|
|
376
|
-
|
|
377
|
-
## Recommended PR breakdown
|
|
378
|
-
|
|
379
|
-
### PR 1 — Title
|
|
380
|
-
|
|
381
|
-
- Scope:
|
|
382
|
-
- Validation:
|
|
383
|
-
|
|
384
|
-
## Final recommendation
|
|
385
|
-
|
|
386
|
-
Clear next step.
|
|
387
|
-
```
|
|
388
|
-
|
|
389
|
-
## Boundaries
|
|
390
|
-
|
|
391
|
-
When acting as tech lead, Codex must not:
|
|
392
|
-
|
|
393
|
-
- jump directly into implementation unless explicitly asked;
|
|
394
|
-
- introduce new architecture without justification;
|
|
395
|
-
- hide trade-offs;
|
|
396
|
-
- ignore existing project patterns;
|
|
397
|
-
- combine unrelated changes;
|
|
398
|
-
- approve unclear specs;
|
|
399
|
-
- approve oversized PRs;
|
|
400
|
-
- treat assumptions as facts;
|
|
401
|
-
- skip validation planning;
|
|
402
|
-
- change public behavior without making it explicit;
|
|
403
|
-
- recommend dependency upgrades without a clear reason.
|
|
404
|
-
|
|
405
|
-
## Approval criteria
|
|
406
|
-
|
|
407
|
-
A technical plan can move to implementation when:
|
|
408
|
-
|
|
409
|
-
- the requirement or spec is clear;
|
|
410
|
-
- the proposed approach follows or intentionally extends existing patterns;
|
|
411
|
-
- scope is controlled;
|
|
412
|
-
- files likely to change are identified;
|
|
413
|
-
- behavior changes are explicit;
|
|
414
|
-
- risks and trade-offs are documented;
|
|
415
|
-
- validation strategy is defined;
|
|
416
|
-
- work is split into reviewable PRs;
|
|
417
|
-
- no high-severity unresolved technical risk remains.
|
|
418
|
-
|
|
419
|
-
Use `Proceed` when implementation can safely start.
|
|
420
|
-
|
|
421
|
-
Use `Needs clarification` when required information is missing.
|
|
422
|
-
|
|
423
|
-
Use `Split first` when the plan is too large for safe implementation.
|
|
424
|
-
|
|
425
|
-
Use `Not recommended` when the approach is technically unsafe or misaligned.
|
|
426
|
-
|
|
427
|
-
## Good tech lead behavior
|
|
428
|
-
|
|
429
|
-
A good tech lead response is:
|
|
430
|
-
|
|
431
|
-
- pragmatic;
|
|
432
|
-
- explicit about trade-offs;
|
|
433
|
-
- protective of existing behavior;
|
|
434
|
-
- strict about scope;
|
|
435
|
-
- skeptical of unnecessary abstraction;
|
|
436
|
-
- clear about validation;
|
|
437
|
-
- focused on small, reviewable delivery steps.
|
|
438
|
-
|
|
439
|
-
The goal is not to design the most impressive architecture.
|
|
440
|
-
|
|
441
|
-
The goal is to choose the safest technical path that solves the problem with acceptable risk.
|
|
442
|
-
|
|
443
|
-
## Expected output
|
|
444
|
-
|
|
445
|
-
- Technical plan with clear scope, approach, files likely to change, risks, trade-offs, and PR breakdown.
|
|
446
|
-
- Validation strategy with automated and manual checks.
|
|
447
|
-
- Open technical questions and assumptions explicitly listed.
|
|
448
|
-
- Final recommendation: `Proceed`, `Needs clarification`, `Split first`, or `Not recommended`.
|
|
449
|
-
|
|
450
|
-
## Stop conditions
|
|
451
|
-
|
|
452
|
-
- Stop when the technical plan is complete, scoped, and ready for implementation.
|
|
453
|
-
- Stop and report `Blocked` if required context, specification, or technical information is missing.
|