bmalph 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +217 -0
- package/bin/bmalph.js +14 -0
- package/bmad/bmm/agents/analyst.agent.yaml +36 -0
- package/bmad/bmm/agents/architect.agent.yaml +28 -0
- package/bmad/bmm/agents/dev.agent.yaml +38 -0
- package/bmad/bmm/agents/pm.agent.yaml +46 -0
- package/bmad/bmm/agents/quick-flow-solo-dev.agent.yaml +32 -0
- package/bmad/bmm/agents/sm.agent.yaml +36 -0
- package/bmad/bmm/agents/tea.agent.yaml +63 -0
- package/bmad/bmm/agents/tech-writer/tech-writer-sidecar/documentation-standards.md +224 -0
- package/bmad/bmm/agents/tech-writer/tech-writer.agent.yaml +45 -0
- package/bmad/bmm/agents/ux-designer.agent.yaml +26 -0
- package/bmad/bmm/data/project-context-template.md +26 -0
- package/bmad/bmm/module-help.csv +31 -0
- package/bmad/bmm/module.yaml +44 -0
- package/bmad/bmm/sub-modules/claude-code/config.yaml +4 -0
- package/bmad/bmm/sub-modules/claude-code/injections.yaml +242 -0
- package/bmad/bmm/sub-modules/claude-code/readme.md +87 -0
- package/bmad/bmm/teams/default-party.csv +21 -0
- package/bmad/bmm/teams/team-fullstack.yaml +12 -0
- package/bmad/bmm/testarch/knowledge/adr-quality-readiness-checklist.md +350 -0
- package/bmad/bmm/testarch/knowledge/api-request.md +442 -0
- package/bmad/bmm/testarch/knowledge/api-testing-patterns.md +843 -0
- package/bmad/bmm/testarch/knowledge/auth-session.md +552 -0
- package/bmad/bmm/testarch/knowledge/burn-in.md +273 -0
- package/bmad/bmm/testarch/knowledge/ci-burn-in.md +675 -0
- package/bmad/bmm/testarch/knowledge/component-tdd.md +486 -0
- package/bmad/bmm/testarch/knowledge/contract-testing.md +957 -0
- package/bmad/bmm/testarch/knowledge/data-factories.md +500 -0
- package/bmad/bmm/testarch/knowledge/email-auth.md +721 -0
- package/bmad/bmm/testarch/knowledge/error-handling.md +725 -0
- package/bmad/bmm/testarch/knowledge/feature-flags.md +750 -0
- package/bmad/bmm/testarch/knowledge/file-utils.md +463 -0
- package/bmad/bmm/testarch/knowledge/fixture-architecture.md +401 -0
- package/bmad/bmm/testarch/knowledge/fixtures-composition.md +382 -0
- package/bmad/bmm/testarch/knowledge/intercept-network-call.md +430 -0
- package/bmad/bmm/testarch/knowledge/log.md +429 -0
- package/bmad/bmm/testarch/knowledge/network-error-monitor.md +405 -0
- package/bmad/bmm/testarch/knowledge/network-first.md +486 -0
- package/bmad/bmm/testarch/knowledge/network-recorder.md +527 -0
- package/bmad/bmm/testarch/knowledge/nfr-criteria.md +670 -0
- package/bmad/bmm/testarch/knowledge/overview.md +286 -0
- package/bmad/bmm/testarch/knowledge/playwright-config.md +730 -0
- package/bmad/bmm/testarch/knowledge/probability-impact.md +601 -0
- package/bmad/bmm/testarch/knowledge/recurse.md +421 -0
- package/bmad/bmm/testarch/knowledge/risk-governance.md +615 -0
- package/bmad/bmm/testarch/knowledge/selective-testing.md +732 -0
- package/bmad/bmm/testarch/knowledge/selector-resilience.md +527 -0
- package/bmad/bmm/testarch/knowledge/test-healing-patterns.md +644 -0
- package/bmad/bmm/testarch/knowledge/test-levels-framework.md +473 -0
- package/bmad/bmm/testarch/knowledge/test-priorities-matrix.md +373 -0
- package/bmad/bmm/testarch/knowledge/test-quality.md +664 -0
- package/bmad/bmm/testarch/knowledge/timing-debugging.md +372 -0
- package/bmad/bmm/testarch/knowledge/visual-debugging.md +524 -0
- package/bmad/bmm/testarch/tea-index.csv +35 -0
- package/bmad/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -0
- package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +177 -0
- package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +161 -0
- package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +199 -0
- package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +202 -0
- package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +205 -0
- package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +219 -0
- package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +162 -0
- package/bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md +58 -0
- package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -0
- package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -0
- package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -0
- package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -0
- package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -0
- package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +443 -0
- package/bmad/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -0
- package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -0
- package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +200 -0
- package/bmad/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -0
- package/bmad/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -0
- package/bmad/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -0
- package/bmad/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +475 -0
- package/bmad/bmm/workflows/1-analysis/research/research.template.md +29 -0
- package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -0
- package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -0
- package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -0
- package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -0
- package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +239 -0
- package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +486 -0
- package/bmad/bmm/workflows/1-analysis/research/workflow.md +173 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +248 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +171 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +43 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/data/domain-complexity.csv +13 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md +197 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/data/project-types.csv +11 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-01-init.md +191 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-01b-continue.md +153 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md +224 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-03-success.md +226 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md +213 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md +207 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-06-innovation.md +226 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-07-project-type.md +237 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-08-scoping.md +228 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-09-functional.md +231 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-10-nonfunctional.md +242 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md +217 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md +124 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md +247 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md +208 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md +249 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md +253 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md +168 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md +218 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md +191 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md +209 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md +174 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md +214 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md +228 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md +217 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md +205 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md +243 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md +263 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md +209 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md +264 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md +242 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md +231 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/templates/prd-template.md +10 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md +433 -0
- package/bmad/bmm/workflows/2-plan-workflows/prd/workflow.md +150 -0
- package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +190 -0
- package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +178 -0
- package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +179 -0
- package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +139 -0
- package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +252 -0
- package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +135 -0
- package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -0
- package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +55 -0
- package/bmad/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -0
- package/bmad/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +11 -0
- package/bmad/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +7 -0
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +153 -0
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +164 -0
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -0
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +331 -0
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +318 -0
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +359 -0
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -0
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +359 -0
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +76 -0
- package/bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md +50 -0
- package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -0
- package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -0
- package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -0
- package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +149 -0
- package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -0
- package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +59 -0
- package/bmad/bmm/workflows/4-implementation/code-review/checklist.md +23 -0
- package/bmad/bmm/workflows/4-implementation/code-review/instructions.xml +227 -0
- package/bmad/bmm/workflows/4-implementation/code-review/workflow.yaml +51 -0
- package/bmad/bmm/workflows/4-implementation/correct-course/checklist.md +288 -0
- package/bmad/bmm/workflows/4-implementation/correct-course/instructions.md +206 -0
- package/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml +60 -0
- package/bmad/bmm/workflows/4-implementation/create-story/checklist.md +358 -0
- package/bmad/bmm/workflows/4-implementation/create-story/instructions.xml +345 -0
- package/bmad/bmm/workflows/4-implementation/create-story/template.md +49 -0
- package/bmad/bmm/workflows/4-implementation/create-story/workflow.yaml +61 -0
- package/bmad/bmm/workflows/4-implementation/dev-story/checklist.md +80 -0
- package/bmad/bmm/workflows/4-implementation/dev-story/instructions.xml +410 -0
- package/bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml +27 -0
- package/bmad/bmm/workflows/4-implementation/retrospective/instructions.md +1443 -0
- package/bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml +58 -0
- package/bmad/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -0
- package/bmad/bmm/workflows/4-implementation/sprint-planning/instructions.md +225 -0
- package/bmad/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -0
- package/bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +54 -0
- package/bmad/bmm/workflows/4-implementation/sprint-status/instructions.md +229 -0
- package/bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml +36 -0
- package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/data/project-levels.yaml +59 -0
- package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +156 -0
- package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +120 -0
- package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +113 -0
- package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +113 -0
- package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +106 -0
- package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +140 -0
- package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +50 -0
- package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +189 -0
- package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +144 -0
- package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +128 -0
- package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +191 -0
- package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md +74 -0
- package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +79 -0
- package/bmad/bmm/workflows/document-project/checklist.md +245 -0
- package/bmad/bmm/workflows/document-project/documentation-requirements.csv +12 -0
- package/bmad/bmm/workflows/document-project/instructions.md +221 -0
- package/bmad/bmm/workflows/document-project/templates/deep-dive-template.md +345 -0
- package/bmad/bmm/workflows/document-project/templates/index-template.md +169 -0
- package/bmad/bmm/workflows/document-project/templates/project-overview-template.md +103 -0
- package/bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -0
- package/bmad/bmm/workflows/document-project/templates/source-tree-template.md +135 -0
- package/bmad/bmm/workflows/document-project/workflow.yaml +30 -0
- package/bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -0
- package/bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -0
- package/bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -0
- package/bmad/bmm/workflows/document-project/workflows/full-scan.yaml +31 -0
- package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json +90 -0
- package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml +127 -0
- package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md +39 -0
- package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +130 -0
- package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml +27 -0
- package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md +43 -0
- package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +141 -0
- package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml +27 -0
- package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md +49 -0
- package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +241 -0
- package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml +27 -0
- package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md +38 -0
- package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +133 -0
- package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml +27 -0
- package/bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +363 -0
- package/bmad/bmm/workflows/testarch/atdd/checklist.md +374 -0
- package/bmad/bmm/workflows/testarch/atdd/instructions.md +806 -0
- package/bmad/bmm/workflows/testarch/atdd/workflow.yaml +47 -0
- package/bmad/bmm/workflows/testarch/automate/checklist.md +582 -0
- package/bmad/bmm/workflows/testarch/automate/instructions.md +1324 -0
- package/bmad/bmm/workflows/testarch/automate/workflow.yaml +54 -0
- package/bmad/bmm/workflows/testarch/ci/checklist.md +247 -0
- package/bmad/bmm/workflows/testarch/ci/github-actions-template.yaml +198 -0
- package/bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +149 -0
- package/bmad/bmm/workflows/testarch/ci/instructions.md +536 -0
- package/bmad/bmm/workflows/testarch/ci/workflow.yaml +47 -0
- package/bmad/bmm/workflows/testarch/framework/checklist.md +320 -0
- package/bmad/bmm/workflows/testarch/framework/instructions.md +481 -0
- package/bmad/bmm/workflows/testarch/framework/workflow.yaml +49 -0
- package/bmad/bmm/workflows/testarch/nfr-assess/checklist.md +407 -0
- package/bmad/bmm/workflows/testarch/nfr-assess/instructions.md +726 -0
- package/bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +461 -0
- package/bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml +49 -0
- package/bmad/bmm/workflows/testarch/test-design/checklist.md +407 -0
- package/bmad/bmm/workflows/testarch/test-design/instructions.md +1158 -0
- package/bmad/bmm/workflows/testarch/test-design/test-design-architecture-template.md +213 -0
- package/bmad/bmm/workflows/testarch/test-design/test-design-qa-template.md +286 -0
- package/bmad/bmm/workflows/testarch/test-design/test-design-template.md +294 -0
- package/bmad/bmm/workflows/testarch/test-design/workflow.yaml +71 -0
- package/bmad/bmm/workflows/testarch/test-review/checklist.md +472 -0
- package/bmad/bmm/workflows/testarch/test-review/instructions.md +628 -0
- package/bmad/bmm/workflows/testarch/test-review/test-review-template.md +390 -0
- package/bmad/bmm/workflows/testarch/test-review/workflow.yaml +48 -0
- package/bmad/bmm/workflows/testarch/trace/checklist.md +642 -0
- package/bmad/bmm/workflows/testarch/trace/instructions.md +1030 -0
- package/bmad/bmm/workflows/testarch/trace/trace-template.md +675 -0
- package/bmad/bmm/workflows/testarch/trace/workflow.yaml +57 -0
- package/bmad/core/agents/bmad-master.agent.yaml +30 -0
- package/bmad/core/module-help.csv +11 -0
- package/bmad/core/module.yaml +25 -0
- package/bmad/core/resources/excalidraw/README.md +160 -0
- package/bmad/core/resources/excalidraw/excalidraw-helpers.md +127 -0
- package/bmad/core/resources/excalidraw/library-loader.md +50 -0
- package/bmad/core/resources/excalidraw/validate-json-instructions.md +79 -0
- package/bmad/core/tasks/bmad-help.md +62 -0
- package/bmad/core/tasks/editorial-review-prose.xml +91 -0
- package/bmad/core/tasks/editorial-review-structure.xml +198 -0
- package/bmad/core/tasks/index-docs.xml +65 -0
- package/bmad/core/tasks/review-adversarial-general.xml +48 -0
- package/bmad/core/tasks/shard-doc.xml +109 -0
- package/bmad/core/tasks/workflow.xml +235 -0
- package/bmad/core/workflows/advanced-elicitation/methods.csv +51 -0
- package/bmad/core/workflows/advanced-elicitation/workflow.xml +117 -0
- package/bmad/core/workflows/brainstorming/brain-methods.csv +62 -0
- package/bmad/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -0
- package/bmad/core/workflows/brainstorming/steps/step-01b-continue.md +122 -0
- package/bmad/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -0
- package/bmad/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -0
- package/bmad/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -0
- package/bmad/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -0
- package/bmad/core/workflows/brainstorming/steps/step-03-technique-execution.md +399 -0
- package/bmad/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -0
- package/bmad/core/workflows/brainstorming/template.md +15 -0
- package/bmad/core/workflows/brainstorming/workflow.md +58 -0
- package/bmad/core/workflows/party-mode/steps/step-01-agent-loading.md +138 -0
- package/bmad/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +187 -0
- package/bmad/core/workflows/party-mode/steps/step-03-graceful-exit.md +157 -0
- package/bmad/core/workflows/party-mode/workflow.md +194 -0
- package/dist/cli.d.ts +1 -0
- package/dist/cli.js +26 -0
- package/dist/commands/doctor.d.ts +1 -0
- package/dist/commands/doctor.js +168 -0
- package/dist/commands/guide.d.ts +1 -0
- package/dist/commands/guide.js +19 -0
- package/dist/commands/implement.d.ts +1 -0
- package/dist/commands/implement.js +83 -0
- package/dist/commands/init.d.ts +6 -0
- package/dist/commands/init.js +67 -0
- package/dist/commands/plan.d.ts +5 -0
- package/dist/commands/plan.js +44 -0
- package/dist/commands/reset.d.ts +5 -0
- package/dist/commands/reset.js +35 -0
- package/dist/commands/resume.d.ts +1 -0
- package/dist/commands/resume.js +44 -0
- package/dist/commands/start.d.ts +5 -0
- package/dist/commands/start.js +54 -0
- package/dist/commands/status.d.ts +1 -0
- package/dist/commands/status.js +53 -0
- package/dist/commands/upgrade.d.ts +1 -0
- package/dist/commands/upgrade.js +34 -0
- package/dist/installer.d.ts +11 -0
- package/dist/installer.js +219 -0
- package/dist/transition.d.ts +52 -0
- package/dist/transition.js +656 -0
- package/dist/utils/config.d.ts +7 -0
- package/dist/utils/config.js +14 -0
- package/dist/utils/json.d.ts +7 -0
- package/dist/utils/json.js +26 -0
- package/dist/utils/logger.d.ts +3 -0
- package/dist/utils/logger.js +13 -0
- package/dist/utils/state.d.ts +29 -0
- package/dist/utils/state.js +78 -0
- package/dist/utils/validate.d.ts +4 -0
- package/dist/utils/validate.js +42 -0
- package/package.json +59 -0
- package/ralph/lib/circuit_breaker.sh +330 -0
- package/ralph/lib/date_utils.sh +53 -0
- package/ralph/lib/response_analyzer.sh +768 -0
- package/ralph/lib/timeout_utils.sh +145 -0
- package/ralph/ralph_loop.sh +1391 -0
- package/ralph/templates/AGENT.md +158 -0
- package/ralph/templates/PROMPT.md +292 -0
- package/ralph/templates/fix_plan.md +27 -0
- package/ralph/templates/specs/.gitkeep +2 -0
- package/slash-commands/advanced-elicitation.md +1 -0
- package/slash-commands/adversarial-review.md +1 -0
- package/slash-commands/analyst.md +1 -0
- package/slash-commands/architect.md +1 -0
- package/slash-commands/atdd.md +1 -0
- package/slash-commands/bmad-help.md +1 -0
- package/slash-commands/bmalph-implement.md +152 -0
- package/slash-commands/bmalph.md +1 -0
- package/slash-commands/brainstorm-project.md +1 -0
- package/slash-commands/brainstorming.md +1 -0
- package/slash-commands/continuous-integration.md +1 -0
- package/slash-commands/correct-course.md +1 -0
- package/slash-commands/create-architecture.md +1 -0
- package/slash-commands/create-brief.md +1 -0
- package/slash-commands/create-dataflow.md +1 -0
- package/slash-commands/create-diagram.md +1 -0
- package/slash-commands/create-epics-stories.md +1 -0
- package/slash-commands/create-flowchart.md +1 -0
- package/slash-commands/create-prd.md +1 -0
- package/slash-commands/create-story.md +1 -0
- package/slash-commands/create-ux.md +1 -0
- package/slash-commands/create-wireframe.md +1 -0
- package/slash-commands/dev.md +1 -0
- package/slash-commands/document-project.md +1 -0
- package/slash-commands/domain-research.md +1 -0
- package/slash-commands/editorial-prose.md +1 -0
- package/slash-commands/editorial-structure.md +1 -0
- package/slash-commands/execute-workflow.md +1 -0
- package/slash-commands/implementation-readiness.md +1 -0
- package/slash-commands/index-docs.md +1 -0
- package/slash-commands/market-research.md +1 -0
- package/slash-commands/nfr-assess.md +1 -0
- package/slash-commands/party-mode.md +1 -0
- package/slash-commands/pm.md +1 -0
- package/slash-commands/quick-dev.md +1 -0
- package/slash-commands/quick-flow-solo-dev.md +1 -0
- package/slash-commands/retrospective.md +1 -0
- package/slash-commands/shard-doc.md +1 -0
- package/slash-commands/sm.md +1 -0
- package/slash-commands/sprint-planning.md +1 -0
- package/slash-commands/sprint-status.md +1 -0
- package/slash-commands/tea.md +1 -0
- package/slash-commands/tech-spec.md +1 -0
- package/slash-commands/technical-research.md +1 -0
- package/slash-commands/test-automate.md +1 -0
- package/slash-commands/test-design.md +1 -0
- package/slash-commands/test-framework.md +1 -0
- package/slash-commands/test-review.md +1 -0
- package/slash-commands/test-trace.md +1 -0
- package/slash-commands/ux-designer.md +1 -0
- package/slash-commands/validate-architecture.md +1 -0
- package/slash-commands/validate-brief.md +1 -0
- package/slash-commands/validate-epics-stories.md +1 -0
- package/slash-commands/validate-prd.md +1 -0
- package/slash-commands/validate-story.md +1 -0
- package/slash-commands/validate-test-design.md +1 -0
- package/slash-commands/validate-ux.md +1 -0
|
@@ -0,0 +1,158 @@
|
|
|
1
|
+
# Agent Build Instructions
|
|
2
|
+
|
|
3
|
+
## Project Setup
|
|
4
|
+
```bash
|
|
5
|
+
# Install dependencies (example for Node.js project)
|
|
6
|
+
npm install
|
|
7
|
+
|
|
8
|
+
# Or for Python project
|
|
9
|
+
pip install -r requirements.txt
|
|
10
|
+
|
|
11
|
+
# Or for Rust project
|
|
12
|
+
cargo build
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Running Tests
|
|
16
|
+
```bash
|
|
17
|
+
# Node.js
|
|
18
|
+
npm test
|
|
19
|
+
|
|
20
|
+
# Python
|
|
21
|
+
pytest
|
|
22
|
+
|
|
23
|
+
# Rust
|
|
24
|
+
cargo test
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Build Commands
|
|
28
|
+
```bash
|
|
29
|
+
# Production build
|
|
30
|
+
npm run build
|
|
31
|
+
# or
|
|
32
|
+
cargo build --release
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Development Server
|
|
36
|
+
```bash
|
|
37
|
+
# Start development server
|
|
38
|
+
npm run dev
|
|
39
|
+
# or
|
|
40
|
+
cargo run
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Key Learnings
|
|
44
|
+
- Update this section when you learn new build optimizations
|
|
45
|
+
- Document any gotchas or special setup requirements
|
|
46
|
+
- Keep track of the fastest test/build cycle
|
|
47
|
+
|
|
48
|
+
## Feature Development Quality Standards
|
|
49
|
+
|
|
50
|
+
**CRITICAL**: All new features MUST meet the following mandatory requirements before being considered complete.
|
|
51
|
+
|
|
52
|
+
### Testing Requirements
|
|
53
|
+
|
|
54
|
+
- **Minimum Coverage**: 85% code coverage ratio required for all new code
|
|
55
|
+
- **Test Pass Rate**: 100% - all tests must pass, no exceptions
|
|
56
|
+
- **Test Types Required**:
|
|
57
|
+
- Unit tests for all business logic and services
|
|
58
|
+
- Integration tests for API endpoints or main functionality
|
|
59
|
+
- End-to-end tests for critical user workflows
|
|
60
|
+
- **Coverage Validation**: Run coverage reports before marking features complete:
|
|
61
|
+
```bash
|
|
62
|
+
# Examples by language/framework
|
|
63
|
+
npm run test:coverage
|
|
64
|
+
pytest --cov=src tests/ --cov-report=term-missing
|
|
65
|
+
cargo tarpaulin --out Html
|
|
66
|
+
```
|
|
67
|
+
- **Test Quality**: Tests must validate behavior, not just achieve coverage metrics
|
|
68
|
+
- **Test Documentation**: Complex test scenarios must include comments explaining the test strategy
|
|
69
|
+
|
|
70
|
+
### Git Workflow Requirements
|
|
71
|
+
|
|
72
|
+
Before moving to the next feature, ALL changes must be:
|
|
73
|
+
|
|
74
|
+
1. **Committed with Clear Messages**:
|
|
75
|
+
```bash
|
|
76
|
+
git add .
|
|
77
|
+
git commit -m "feat(module): descriptive message following conventional commits"
|
|
78
|
+
```
|
|
79
|
+
- Use conventional commit format: `feat:`, `fix:`, `docs:`, `test:`, `refactor:`, etc.
|
|
80
|
+
- Include scope when applicable: `feat(api):`, `fix(ui):`, `test(auth):`
|
|
81
|
+
- Write descriptive messages that explain WHAT changed and WHY
|
|
82
|
+
|
|
83
|
+
2. **Pushed to Remote Repository**:
|
|
84
|
+
```bash
|
|
85
|
+
git push origin <branch-name>
|
|
86
|
+
```
|
|
87
|
+
- Never leave completed features uncommitted
|
|
88
|
+
- Push regularly to maintain backup and enable collaboration
|
|
89
|
+
- Ensure CI/CD pipelines pass before considering feature complete
|
|
90
|
+
|
|
91
|
+
3. **Branch Hygiene**:
|
|
92
|
+
- Work on feature branches, never directly on `main`
|
|
93
|
+
- Branch naming convention: `feature/<feature-name>`, `fix/<issue-name>`, `docs/<doc-update>`
|
|
94
|
+
- Create pull requests for all significant changes
|
|
95
|
+
|
|
96
|
+
4. **Ralph Integration**:
|
|
97
|
+
- Update .ralph/@fix_plan.md with new tasks before starting work
|
|
98
|
+
- Mark items complete in .ralph/@fix_plan.md upon completion
|
|
99
|
+
- Update .ralph/PROMPT.md if development patterns change
|
|
100
|
+
- Test features work within Ralph's autonomous loop
|
|
101
|
+
|
|
102
|
+
### Documentation Requirements
|
|
103
|
+
|
|
104
|
+
**ALL implementation documentation MUST remain synchronized with the codebase**:
|
|
105
|
+
|
|
106
|
+
1. **Code Documentation**:
|
|
107
|
+
- Language-appropriate documentation (JSDoc, docstrings, etc.)
|
|
108
|
+
- Update inline comments when implementation changes
|
|
109
|
+
- Remove outdated comments immediately
|
|
110
|
+
|
|
111
|
+
2. **Implementation Documentation**:
|
|
112
|
+
- Update relevant sections in this AGENT.md file
|
|
113
|
+
- Keep build and test commands current
|
|
114
|
+
- Update configuration examples when defaults change
|
|
115
|
+
- Document breaking changes prominently
|
|
116
|
+
|
|
117
|
+
3. **README Updates**:
|
|
118
|
+
- Keep feature lists current
|
|
119
|
+
- Update setup instructions when dependencies change
|
|
120
|
+
- Maintain accurate command examples
|
|
121
|
+
- Update version compatibility information
|
|
122
|
+
|
|
123
|
+
4. **AGENT.md Maintenance**:
|
|
124
|
+
- Add new build patterns to relevant sections
|
|
125
|
+
- Update "Key Learnings" with new insights
|
|
126
|
+
- Keep command examples accurate and tested
|
|
127
|
+
- Document new testing patterns or quality gates
|
|
128
|
+
|
|
129
|
+
### Feature Completion Checklist
|
|
130
|
+
|
|
131
|
+
Before marking ANY feature as complete, verify:
|
|
132
|
+
|
|
133
|
+
- [ ] All tests pass with appropriate framework command
|
|
134
|
+
- [ ] Code coverage meets 85% minimum threshold
|
|
135
|
+
- [ ] Coverage report reviewed for meaningful test quality
|
|
136
|
+
- [ ] Code formatted according to project standards
|
|
137
|
+
- [ ] Type checking passes (if applicable)
|
|
138
|
+
- [ ] All changes committed with conventional commit messages
|
|
139
|
+
- [ ] All commits pushed to remote repository
|
|
140
|
+
- [ ] .ralph/@fix_plan.md task marked as complete
|
|
141
|
+
- [ ] Implementation documentation updated
|
|
142
|
+
- [ ] Inline code comments updated or added
|
|
143
|
+
- [ ] .ralph/@AGENT.md updated (if new patterns introduced)
|
|
144
|
+
- [ ] Breaking changes documented
|
|
145
|
+
- [ ] Features tested within Ralph loop (if applicable)
|
|
146
|
+
- [ ] CI/CD pipeline passes
|
|
147
|
+
|
|
148
|
+
### Rationale
|
|
149
|
+
|
|
150
|
+
These standards ensure:
|
|
151
|
+
- **Quality**: High test coverage and pass rates prevent regressions
|
|
152
|
+
- **Traceability**: Git commits and .ralph/@fix_plan.md provide clear history of changes
|
|
153
|
+
- **Maintainability**: Current documentation reduces onboarding time and prevents knowledge loss
|
|
154
|
+
- **Collaboration**: Pushed changes enable team visibility and code review
|
|
155
|
+
- **Reliability**: Consistent quality gates maintain production stability
|
|
156
|
+
- **Automation**: Ralph integration ensures continuous development practices
|
|
157
|
+
|
|
158
|
+
**Enforcement**: AI agents should automatically apply these standards to all feature development tasks without requiring explicit instruction for each task.
|
|
@@ -0,0 +1,292 @@
|
|
|
1
|
+
# Ralph Development Instructions
|
|
2
|
+
|
|
3
|
+
## Context
|
|
4
|
+
You are Ralph, an autonomous AI development agent working on a [YOUR PROJECT NAME] project.
|
|
5
|
+
|
|
6
|
+
## Current Objectives
|
|
7
|
+
1. Read .ralph/PROJECT_CONTEXT.md for project goals, constraints, and scope
|
|
8
|
+
2. **Check .ralph/SPECS_CHANGELOG.md** (if present) to see what changed since last run
|
|
9
|
+
3. Study .ralph/specs/ for BMAD planning output:
|
|
10
|
+
- planning-artifacts/: PRD, architecture, epics/stories, test design, UX
|
|
11
|
+
- implementation-artifacts/: sprint plans, detailed stories (if present)
|
|
12
|
+
- brainstorming/: brainstorming sessions (if present)
|
|
13
|
+
4. Check docs/ for project knowledge and research documents (if present)
|
|
14
|
+
5. Review .ralph/@fix_plan.md for current priorities
|
|
15
|
+
6. Implement the highest priority item using best practices
|
|
16
|
+
7. Use parallel subagents for complex tasks (max 100 concurrent)
|
|
17
|
+
8. Run tests after each implementation
|
|
18
|
+
9. Update documentation and fix_plan.md
|
|
19
|
+
|
|
20
|
+
## Key Principles
|
|
21
|
+
- ONE task per loop - focus on the most important thing
|
|
22
|
+
- Search the codebase before assuming something isn't implemented
|
|
23
|
+
- Use subagents for expensive operations (file searching, analysis)
|
|
24
|
+
- Write comprehensive tests with clear documentation
|
|
25
|
+
- Update .ralph/@fix_plan.md with your learnings
|
|
26
|
+
- Commit working changes with descriptive messages
|
|
27
|
+
|
|
28
|
+
## 🧪 Testing Guidelines (CRITICAL)
|
|
29
|
+
- LIMIT testing to ~20% of your total effort per loop
|
|
30
|
+
- PRIORITIZE: Implementation > Documentation > Tests
|
|
31
|
+
- Only write tests for NEW functionality you implement
|
|
32
|
+
- Do NOT refactor existing tests unless broken
|
|
33
|
+
- Do NOT add "additional test coverage" as busy work
|
|
34
|
+
- Focus on CORE functionality first, comprehensive testing later
|
|
35
|
+
|
|
36
|
+
## Execution Guidelines
|
|
37
|
+
- Before making changes: search codebase using subagents
|
|
38
|
+
- After implementation: run ESSENTIAL tests for the modified code only
|
|
39
|
+
- If tests fail: fix them as part of your current work
|
|
40
|
+
- Keep .ralph/@AGENT.md updated with build/run instructions
|
|
41
|
+
- Document the WHY behind tests and implementations
|
|
42
|
+
- No placeholder implementations - build it properly
|
|
43
|
+
|
|
44
|
+
## 🎯 Status Reporting (CRITICAL - Ralph needs this!)
|
|
45
|
+
|
|
46
|
+
**IMPORTANT**: At the end of your response, ALWAYS include this status block:
|
|
47
|
+
|
|
48
|
+
```
|
|
49
|
+
---RALPH_STATUS---
|
|
50
|
+
STATUS: IN_PROGRESS | COMPLETE | BLOCKED
|
|
51
|
+
TASKS_COMPLETED_THIS_LOOP: <number>
|
|
52
|
+
FILES_MODIFIED: <number>
|
|
53
|
+
TESTS_STATUS: PASSING | FAILING | NOT_RUN
|
|
54
|
+
WORK_TYPE: IMPLEMENTATION | TESTING | DOCUMENTATION | REFACTORING
|
|
55
|
+
EXIT_SIGNAL: false | true
|
|
56
|
+
RECOMMENDATION: <one line summary of what to do next>
|
|
57
|
+
---END_RALPH_STATUS---
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### When to set EXIT_SIGNAL: true
|
|
61
|
+
|
|
62
|
+
Set EXIT_SIGNAL to **true** when ALL of these conditions are met:
|
|
63
|
+
1. ✅ All items in @fix_plan.md are marked [x]
|
|
64
|
+
2. ✅ All tests are passing (or no tests exist for valid reasons)
|
|
65
|
+
3. ✅ No errors or warnings in the last execution
|
|
66
|
+
4. ✅ All requirements from specs/ are implemented
|
|
67
|
+
5. ✅ You have nothing meaningful left to implement
|
|
68
|
+
|
|
69
|
+
### Examples of proper status reporting:
|
|
70
|
+
|
|
71
|
+
**Example 1: Work in progress**
|
|
72
|
+
```
|
|
73
|
+
---RALPH_STATUS---
|
|
74
|
+
STATUS: IN_PROGRESS
|
|
75
|
+
TASKS_COMPLETED_THIS_LOOP: 2
|
|
76
|
+
FILES_MODIFIED: 5
|
|
77
|
+
TESTS_STATUS: PASSING
|
|
78
|
+
WORK_TYPE: IMPLEMENTATION
|
|
79
|
+
EXIT_SIGNAL: false
|
|
80
|
+
RECOMMENDATION: Continue with next priority task from @fix_plan.md
|
|
81
|
+
---END_RALPH_STATUS---
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
**Example 2: Project complete**
|
|
85
|
+
```
|
|
86
|
+
---RALPH_STATUS---
|
|
87
|
+
STATUS: COMPLETE
|
|
88
|
+
TASKS_COMPLETED_THIS_LOOP: 1
|
|
89
|
+
FILES_MODIFIED: 1
|
|
90
|
+
TESTS_STATUS: PASSING
|
|
91
|
+
WORK_TYPE: DOCUMENTATION
|
|
92
|
+
EXIT_SIGNAL: true
|
|
93
|
+
RECOMMENDATION: All requirements met, project ready for review
|
|
94
|
+
---END_RALPH_STATUS---
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
**Example 3: Stuck/blocked**
|
|
98
|
+
```
|
|
99
|
+
---RALPH_STATUS---
|
|
100
|
+
STATUS: BLOCKED
|
|
101
|
+
TASKS_COMPLETED_THIS_LOOP: 0
|
|
102
|
+
FILES_MODIFIED: 0
|
|
103
|
+
TESTS_STATUS: FAILING
|
|
104
|
+
WORK_TYPE: DEBUGGING
|
|
105
|
+
EXIT_SIGNAL: false
|
|
106
|
+
RECOMMENDATION: Need human help - same error for 3 loops
|
|
107
|
+
---END_RALPH_STATUS---
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### What NOT to do:
|
|
111
|
+
- ❌ Do NOT continue with busy work when EXIT_SIGNAL should be true
|
|
112
|
+
- ❌ Do NOT run tests repeatedly without implementing new features
|
|
113
|
+
- ❌ Do NOT refactor code that is already working fine
|
|
114
|
+
- ❌ Do NOT add features not in the specifications
|
|
115
|
+
- ❌ Do NOT forget to include the status block (Ralph depends on it!)
|
|
116
|
+
|
|
117
|
+
## 📋 Exit Scenarios (Specification by Example)
|
|
118
|
+
|
|
119
|
+
Ralph's circuit breaker and response analyzer use these scenarios to detect completion.
|
|
120
|
+
Each scenario shows the exact conditions and expected behavior.
|
|
121
|
+
|
|
122
|
+
### Scenario 1: Successful Project Completion
|
|
123
|
+
**Given**:
|
|
124
|
+
- All items in .ralph/@fix_plan.md are marked [x]
|
|
125
|
+
- Last test run shows all tests passing
|
|
126
|
+
- No errors in recent logs/
|
|
127
|
+
- All requirements from .ralph/specs/ are implemented
|
|
128
|
+
|
|
129
|
+
**When**: You evaluate project status at end of loop
|
|
130
|
+
|
|
131
|
+
**Then**: You must output:
|
|
132
|
+
```
|
|
133
|
+
---RALPH_STATUS---
|
|
134
|
+
STATUS: COMPLETE
|
|
135
|
+
TASKS_COMPLETED_THIS_LOOP: 1
|
|
136
|
+
FILES_MODIFIED: 1
|
|
137
|
+
TESTS_STATUS: PASSING
|
|
138
|
+
WORK_TYPE: DOCUMENTATION
|
|
139
|
+
EXIT_SIGNAL: true
|
|
140
|
+
RECOMMENDATION: All requirements met, project ready for review
|
|
141
|
+
---END_RALPH_STATUS---
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
**Ralph's Action**: Detects EXIT_SIGNAL=true, gracefully exits loop with success message
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
### Scenario 2: Test-Only Loop Detected
|
|
149
|
+
**Given**:
|
|
150
|
+
- Last 3 loops only executed tests (npm test, bats, pytest, etc.)
|
|
151
|
+
- No new files were created
|
|
152
|
+
- No existing files were modified
|
|
153
|
+
- No implementation work was performed
|
|
154
|
+
|
|
155
|
+
**When**: You start a new loop iteration
|
|
156
|
+
|
|
157
|
+
**Then**: You must output:
|
|
158
|
+
```
|
|
159
|
+
---RALPH_STATUS---
|
|
160
|
+
STATUS: IN_PROGRESS
|
|
161
|
+
TASKS_COMPLETED_THIS_LOOP: 0
|
|
162
|
+
FILES_MODIFIED: 0
|
|
163
|
+
TESTS_STATUS: PASSING
|
|
164
|
+
WORK_TYPE: TESTING
|
|
165
|
+
EXIT_SIGNAL: false
|
|
166
|
+
RECOMMENDATION: All tests passing, no implementation needed
|
|
167
|
+
---END_RALPH_STATUS---
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
**Ralph's Action**: Increments test_only_loops counter, exits after 3 consecutive test-only loops
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
### Scenario 3: Stuck on Recurring Error
|
|
175
|
+
**Given**:
|
|
176
|
+
- Same error appears in last 5 consecutive loops
|
|
177
|
+
- No progress on fixing the error
|
|
178
|
+
- Error message is identical or very similar
|
|
179
|
+
|
|
180
|
+
**When**: You encounter the same error again
|
|
181
|
+
|
|
182
|
+
**Then**: You must output:
|
|
183
|
+
```
|
|
184
|
+
---RALPH_STATUS---
|
|
185
|
+
STATUS: BLOCKED
|
|
186
|
+
TASKS_COMPLETED_THIS_LOOP: 0
|
|
187
|
+
FILES_MODIFIED: 2
|
|
188
|
+
TESTS_STATUS: FAILING
|
|
189
|
+
WORK_TYPE: DEBUGGING
|
|
190
|
+
EXIT_SIGNAL: false
|
|
191
|
+
RECOMMENDATION: Stuck on [error description] - human intervention needed
|
|
192
|
+
---END_RALPH_STATUS---
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
**Ralph's Action**: Circuit breaker detects repeated errors, opens circuit after 5 loops
|
|
196
|
+
|
|
197
|
+
---
|
|
198
|
+
|
|
199
|
+
### Scenario 4: No Work Remaining
|
|
200
|
+
**Given**:
|
|
201
|
+
- All tasks in @fix_plan.md are complete
|
|
202
|
+
- You analyze .ralph/specs/ and find nothing new to implement
|
|
203
|
+
- Code quality is acceptable
|
|
204
|
+
- Tests are passing
|
|
205
|
+
|
|
206
|
+
**When**: You search for work to do and find none
|
|
207
|
+
|
|
208
|
+
**Then**: You must output:
|
|
209
|
+
```
|
|
210
|
+
---RALPH_STATUS---
|
|
211
|
+
STATUS: COMPLETE
|
|
212
|
+
TASKS_COMPLETED_THIS_LOOP: 0
|
|
213
|
+
FILES_MODIFIED: 0
|
|
214
|
+
TESTS_STATUS: PASSING
|
|
215
|
+
WORK_TYPE: DOCUMENTATION
|
|
216
|
+
EXIT_SIGNAL: true
|
|
217
|
+
RECOMMENDATION: No remaining work, all .ralph/specs implemented
|
|
218
|
+
---END_RALPH_STATUS---
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
**Ralph's Action**: Detects completion signal, exits loop immediately
|
|
222
|
+
|
|
223
|
+
---
|
|
224
|
+
|
|
225
|
+
### Scenario 5: Making Progress
|
|
226
|
+
**Given**:
|
|
227
|
+
- Tasks remain in .ralph/@fix_plan.md
|
|
228
|
+
- Implementation is underway
|
|
229
|
+
- Files are being modified
|
|
230
|
+
- Tests are passing or being fixed
|
|
231
|
+
|
|
232
|
+
**When**: You complete a task successfully
|
|
233
|
+
|
|
234
|
+
**Then**: You must output:
|
|
235
|
+
```
|
|
236
|
+
---RALPH_STATUS---
|
|
237
|
+
STATUS: IN_PROGRESS
|
|
238
|
+
TASKS_COMPLETED_THIS_LOOP: 3
|
|
239
|
+
FILES_MODIFIED: 7
|
|
240
|
+
TESTS_STATUS: PASSING
|
|
241
|
+
WORK_TYPE: IMPLEMENTATION
|
|
242
|
+
EXIT_SIGNAL: false
|
|
243
|
+
RECOMMENDATION: Continue with next task from .ralph/@fix_plan.md
|
|
244
|
+
---END_RALPH_STATUS---
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
**Ralph's Action**: Continues loop, circuit breaker stays CLOSED (normal operation)
|
|
248
|
+
|
|
249
|
+
---
|
|
250
|
+
|
|
251
|
+
### Scenario 6: Blocked on External Dependency
|
|
252
|
+
**Given**:
|
|
253
|
+
- Task requires external API, library, or human decision
|
|
254
|
+
- Cannot proceed without missing information
|
|
255
|
+
- Have tried reasonable workarounds
|
|
256
|
+
|
|
257
|
+
**When**: You identify the blocker
|
|
258
|
+
|
|
259
|
+
**Then**: You must output:
|
|
260
|
+
```
|
|
261
|
+
---RALPH_STATUS---
|
|
262
|
+
STATUS: BLOCKED
|
|
263
|
+
TASKS_COMPLETED_THIS_LOOP: 0
|
|
264
|
+
FILES_MODIFIED: 0
|
|
265
|
+
TESTS_STATUS: NOT_RUN
|
|
266
|
+
WORK_TYPE: IMPLEMENTATION
|
|
267
|
+
EXIT_SIGNAL: false
|
|
268
|
+
RECOMMENDATION: Blocked on [specific dependency] - need [what's needed]
|
|
269
|
+
---END_RALPH_STATUS---
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
**Ralph's Action**: Logs blocker, may exit after multiple blocked loops
|
|
273
|
+
|
|
274
|
+
---
|
|
275
|
+
|
|
276
|
+
## File Structure
|
|
277
|
+
- .ralph/: Ralph-specific configuration and documentation
|
|
278
|
+
- PROJECT_CONTEXT.md: High-level project goals, constraints, and scope
|
|
279
|
+
- specs/: Project specifications and requirements
|
|
280
|
+
- @fix_plan.md: Prioritized TODO list
|
|
281
|
+
- @AGENT.md: Project build and run instructions
|
|
282
|
+
- PROMPT.md: This file - Ralph development instructions
|
|
283
|
+
- logs/: Loop execution logs
|
|
284
|
+
- docs/generated/: Auto-generated documentation
|
|
285
|
+
- src/: Source code implementation
|
|
286
|
+
- examples/: Example usage and test cases
|
|
287
|
+
|
|
288
|
+
## Current Task
|
|
289
|
+
Follow .ralph/@fix_plan.md and choose the most important item to implement next.
|
|
290
|
+
Use your judgment to prioritize what will have the biggest impact on project progress.
|
|
291
|
+
|
|
292
|
+
Remember: Quality over speed. Build it right the first time. Know when you're done.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# Ralph Fix Plan
|
|
2
|
+
|
|
3
|
+
## High Priority
|
|
4
|
+
- [ ] Set up basic project structure and build system
|
|
5
|
+
- [ ] Define core data structures and types
|
|
6
|
+
- [ ] Implement basic input/output handling
|
|
7
|
+
- [ ] Create test framework and initial tests
|
|
8
|
+
|
|
9
|
+
## Medium Priority
|
|
10
|
+
- [ ] Add error handling and validation
|
|
11
|
+
- [ ] Implement core business logic
|
|
12
|
+
- [ ] Add configuration management
|
|
13
|
+
- [ ] Create user documentation
|
|
14
|
+
|
|
15
|
+
## Low Priority
|
|
16
|
+
- [ ] Performance optimization
|
|
17
|
+
- [ ] Extended feature set
|
|
18
|
+
- [ ] Integration with external services
|
|
19
|
+
- [ ] Advanced error recovery
|
|
20
|
+
|
|
21
|
+
## Completed
|
|
22
|
+
- [x] Project initialization
|
|
23
|
+
|
|
24
|
+
## Notes
|
|
25
|
+
- Focus on MVP functionality first
|
|
26
|
+
- Ensure each feature is properly tested
|
|
27
|
+
- Update this file after each major milestone
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Read and execute the workflow/task at `_bmad/core/workflows/advanced-elicitation/workflow.xml`.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Read and execute the workflow/task at `_bmad/core/tasks/review-adversarial-general.xml`.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Read and follow the agent defined in `_bmad/bmm/agents/analyst.agent.yaml`.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Read and follow the agent defined in `_bmad/bmm/agents/architect.agent.yaml`.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Adopt the role of the agent defined in `_bmad/bmm/agents/tea.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/testarch/atdd/workflow.yaml`.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Read and execute the workflow/task at `_bmad/core/tasks/bmad-help.md`.
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
# Start Implementation
|
|
2
|
+
|
|
3
|
+
Transition from BMAD planning (Phase 3) to Ralph implementation (Phase 4).
|
|
4
|
+
|
|
5
|
+
## Prerequisites
|
|
6
|
+
|
|
7
|
+
- bmalph must be initialized (`bmalph/config.json` must exist)
|
|
8
|
+
- Stories must exist in `_bmad-output/planning-artifacts/`
|
|
9
|
+
|
|
10
|
+
## Steps
|
|
11
|
+
|
|
12
|
+
### 1. Validate Prerequisites
|
|
13
|
+
|
|
14
|
+
Check that:
|
|
15
|
+
- `bmalph/config.json` exists
|
|
16
|
+
- `.ralph/ralph_loop.sh` exists
|
|
17
|
+
- `_bmad-output/planning-artifacts/` exists with story files
|
|
18
|
+
|
|
19
|
+
If any are missing, report the error and suggest running the required commands.
|
|
20
|
+
|
|
21
|
+
### 2. Parse Stories
|
|
22
|
+
|
|
23
|
+
Read `_bmad-output/planning-artifacts/stories.md` (or any file matching `*stor*.md` or `*epic*.md`):
|
|
24
|
+
- Extract epics: `## Epic N: Title`
|
|
25
|
+
- Extract stories: `### Story N.M: Title`
|
|
26
|
+
- Parse acceptance criteria (Given/When/Then blocks)
|
|
27
|
+
|
|
28
|
+
### 3. Generate `.ralph/@fix_plan.md`
|
|
29
|
+
|
|
30
|
+
Create an ordered list of stories as checkboxes:
|
|
31
|
+
|
|
32
|
+
```markdown
|
|
33
|
+
# Ralph Fix Plan
|
|
34
|
+
|
|
35
|
+
## Stories to Implement
|
|
36
|
+
|
|
37
|
+
### [Epic Title]
|
|
38
|
+
> Goal: [Epic description]
|
|
39
|
+
|
|
40
|
+
- [ ] Story 1.1: [Title]
|
|
41
|
+
> [Description line 1]
|
|
42
|
+
> AC: Given..., When..., Then...
|
|
43
|
+
|
|
44
|
+
## Completed
|
|
45
|
+
|
|
46
|
+
## Notes
|
|
47
|
+
- Follow TDD methodology (red-green-refactor)
|
|
48
|
+
- One story per Ralph loop iteration
|
|
49
|
+
- Update this file after completing each story
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
**Important:** If existing `@fix_plan.md` has completed items `[x]`, preserve their completion status in the new file.
|
|
53
|
+
|
|
54
|
+
### 4. Generate `.ralph/PROJECT_CONTEXT.md`
|
|
55
|
+
|
|
56
|
+
Extract from planning artifacts:
|
|
57
|
+
- Project goals from PRD (Executive Summary, Vision, Goals sections)
|
|
58
|
+
- Success metrics from PRD
|
|
59
|
+
- Architecture constraints from architecture document
|
|
60
|
+
- Technical risks from architecture document
|
|
61
|
+
- Scope boundaries from PRD
|
|
62
|
+
- Target users from PRD
|
|
63
|
+
- Non-functional requirements from PRD
|
|
64
|
+
|
|
65
|
+
Format as:
|
|
66
|
+
|
|
67
|
+
```markdown
|
|
68
|
+
# [Project Name] — Project Context
|
|
69
|
+
|
|
70
|
+
## Project Goals
|
|
71
|
+
[extracted content]
|
|
72
|
+
|
|
73
|
+
## Success Metrics
|
|
74
|
+
[extracted content]
|
|
75
|
+
|
|
76
|
+
## Architecture Constraints
|
|
77
|
+
[extracted content]
|
|
78
|
+
|
|
79
|
+
## Technical Risks
|
|
80
|
+
[extracted content]
|
|
81
|
+
|
|
82
|
+
## Scope Boundaries
|
|
83
|
+
[extracted content]
|
|
84
|
+
|
|
85
|
+
## Target Users
|
|
86
|
+
[extracted content]
|
|
87
|
+
|
|
88
|
+
## Non-Functional Requirements
|
|
89
|
+
[extracted content]
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### 5. Copy Specs to `.ralph/specs/`
|
|
93
|
+
|
|
94
|
+
Copy the entire `_bmad-output/` tree to `.ralph/specs/`:
|
|
95
|
+
- This includes `planning-artifacts/`, `implementation-artifacts/`, etc.
|
|
96
|
+
- Preserve directory structure
|
|
97
|
+
|
|
98
|
+
If specs existed before, generate `SPECS_CHANGELOG.md`:
|
|
99
|
+
```markdown
|
|
100
|
+
# Specs Changelog
|
|
101
|
+
|
|
102
|
+
Last updated: [timestamp]
|
|
103
|
+
|
|
104
|
+
## Added
|
|
105
|
+
- [new files]
|
|
106
|
+
|
|
107
|
+
## Modified
|
|
108
|
+
- [changed files]
|
|
109
|
+
|
|
110
|
+
## Removed
|
|
111
|
+
- [deleted files]
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### 6. Update State
|
|
115
|
+
|
|
116
|
+
Update `bmalph/state/current-phase.json`:
|
|
117
|
+
```json
|
|
118
|
+
{
|
|
119
|
+
"currentPhase": 4,
|
|
120
|
+
"status": "implementing",
|
|
121
|
+
"startedAt": "[original or now]",
|
|
122
|
+
"lastUpdated": "[now]"
|
|
123
|
+
}
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### 7. Report Results
|
|
127
|
+
|
|
128
|
+
Output:
|
|
129
|
+
- Number of stories found
|
|
130
|
+
- Any warnings (missing PRD, architecture, NO-GO status in readiness report)
|
|
131
|
+
- Whether fix_plan progress was preserved
|
|
132
|
+
|
|
133
|
+
### 8. Instruct User
|
|
134
|
+
|
|
135
|
+
Display:
|
|
136
|
+
|
|
137
|
+
```
|
|
138
|
+
Transition complete. To start the Ralph autonomous loop:
|
|
139
|
+
|
|
140
|
+
bash .ralph/ralph_loop.sh
|
|
141
|
+
|
|
142
|
+
Or in a separate terminal for background execution:
|
|
143
|
+
|
|
144
|
+
nohup bash .ralph/ralph_loop.sh > .ralph/logs/ralph.log 2>&1 &
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
## Warnings to Check
|
|
148
|
+
|
|
149
|
+
- No PRD document found
|
|
150
|
+
- No architecture document found
|
|
151
|
+
- Readiness report indicates NO-GO status
|
|
152
|
+
- No stories parsed from the epics file
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Read and follow the agent defined in `_bmad/core/agents/bmad-master.agent.yaml`.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Adopt the role of the agent defined in `_bmad/bmm/agents/analyst.agent.yaml`, then read and execute the workflow at `_bmad/core/workflows/brainstorming/workflow.md` using `_bmad/bmm/data/project-context-template.md` as context data.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Read and execute the workflow/task at `_bmad/core/workflows/brainstorming/workflow.md`.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Adopt the role of the agent defined in `_bmad/bmm/agents/tea.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/testarch/ci/workflow.yaml`.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Adopt the role of the agent defined in `_bmad/bmm/agents/sm.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml` in Create mode.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Adopt the role of the agent defined in `_bmad/bmm/agents/architect.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md` in Create mode.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Adopt the role of the agent defined in `_bmad/bmm/agents/analyst.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md` in Create mode.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Adopt the role of the agent defined in `_bmad/bmm/agents/ux-designer.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml`.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Adopt the role of the agent defined in `_bmad/bmm/agents/ux-designer.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml`.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Adopt the role of the agent defined in `_bmad/bmm/agents/pm.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md` in Create mode.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Adopt the role of the agent defined in `_bmad/bmm/agents/ux-designer.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml`.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
Adopt the role of the agent defined in `_bmad/bmm/agents/pm.agent.yaml`, then read and execute the workflow at `_bmad/bmm/workflows/2-plan-workflows/prd/workflow.md` in Create mode.
|