bmad-fh 6.0.0-alpha.052779ef
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/.coderabbit.yaml +40 -0
- package/.githooks/post-checkout +129 -0
- package/.githooks/pre-commit +63 -0
- package/.githooks/pre-push +135 -0
- package/.github/CODE_OF_CONDUCT.md +128 -0
- package/.github/FUNDING.yaml +15 -0
- package/.github/ISSUE_TEMPLATE/config.yaml +8 -0
- package/.github/ISSUE_TEMPLATE/feature_request.md +22 -0
- package/.github/ISSUE_TEMPLATE/issue.md +32 -0
- package/.github/scripts/discord-helpers.sh +34 -0
- package/.github/workflows/bundle-latest.yaml +330 -0
- package/.github/workflows/discord.yaml +90 -0
- package/.github/workflows/docs.yaml +63 -0
- package/.github/workflows/manual-release.yaml +190 -0
- package/.github/workflows/publish-multi-artifact.yaml +54 -0
- package/.github/workflows/quality.yaml +115 -0
- package/.husky/pre-commit +20 -0
- package/.markdownlint-cli2.yaml +41 -0
- package/.nvmrc +1 -0
- package/.prettierignore +9 -0
- package/.vscode/settings.json +97 -0
- package/CHANGELOG.md +1394 -0
- package/CNAME +1 -0
- package/CONTRIBUTING.md +306 -0
- package/CONTRIBUTORS.md +32 -0
- package/LICENSE +30 -0
- package/README.md +126 -0
- package/SECURITY.md +85 -0
- package/TRADEMARK.md +55 -0
- package/Wordmark.png +0 -0
- package/banner-bmad-method.png +0 -0
- package/docs/404.md +9 -0
- package/docs/_README_WORKFLOW_DIAGRAMS.md +40 -0
- package/docs/_STYLE_GUIDE.md +367 -0
- package/docs/_archive/customize-workflows.md +30 -0
- package/docs/_archive/getting-started-bmadv4.md +247 -0
- package/docs/_archive/vendor-workflows.md +52 -0
- package/docs/downloads.md +72 -0
- package/docs/explanation/agents/barry-quick-flow.md +328 -0
- package/docs/explanation/agents/index.md +19 -0
- package/docs/explanation/architecture/four-phases.md +107 -0
- package/docs/explanation/architecture/preventing-agent-conflicts.md +111 -0
- package/docs/explanation/architecture/why-solutioning-matters.md +75 -0
- package/docs/explanation/bmm/index.md +131 -0
- package/docs/explanation/core/index.md +18 -0
- package/docs/explanation/core-concepts/agent-roles.md +179 -0
- package/docs/explanation/core-concepts/index.md +35 -0
- package/docs/explanation/core-concepts/what-are-agents.md +97 -0
- package/docs/explanation/core-concepts/what-are-modules.md +85 -0
- package/docs/explanation/core-concepts/what-are-workflows.md +204 -0
- package/docs/explanation/faq/brownfield-faq.md +73 -0
- package/docs/explanation/faq/getting-started-faq.md +67 -0
- package/docs/explanation/faq/implementation-faq.md +52 -0
- package/docs/explanation/faq/index.md +16 -0
- package/docs/explanation/faq/levels-and-tracks-faq.md +52 -0
- package/docs/explanation/faq/planning-faq.md +41 -0
- package/docs/explanation/faq/tools-faq.md +277 -0
- package/docs/explanation/faq/workflows-faq.md +61 -0
- package/docs/explanation/features/advanced-elicitation.md +95 -0
- package/docs/explanation/features/brainstorming-techniques.md +92 -0
- package/docs/explanation/features/party-mode.md +95 -0
- package/docs/explanation/features/quick-flow.md +149 -0
- package/docs/explanation/features/tea-overview.md +410 -0
- package/docs/explanation/features/web-bundles.md +34 -0
- package/docs/explanation/philosophy/facilitation-over-generation.md +333 -0
- package/docs/explanation/philosophy/testing-as-engineering.md +112 -0
- package/docs/explanation/tea/engagement-models.md +710 -0
- package/docs/explanation/tea/fixture-architecture.md +457 -0
- package/docs/explanation/tea/knowledge-base-system.md +554 -0
- package/docs/explanation/tea/network-first-patterns.md +853 -0
- package/docs/explanation/tea/risk-based-testing.md +586 -0
- package/docs/explanation/tea/test-quality-standards.md +907 -0
- package/docs/how-to/brownfield/add-feature-to-existing.md +74 -0
- package/docs/how-to/brownfield/document-existing-project.md +66 -0
- package/docs/how-to/brownfield/index.md +84 -0
- package/docs/how-to/brownfield/quick-fix-in-brownfield.md +77 -0
- package/docs/how-to/brownfield/use-tea-for-enterprise.md +526 -0
- package/docs/how-to/brownfield/use-tea-with-existing-tests.md +577 -0
- package/docs/how-to/customization/customize-agents.md +212 -0
- package/docs/how-to/customization/enable-tea-mcp-enhancements.md +424 -0
- package/docs/how-to/customization/index.md +23 -0
- package/docs/how-to/customization/integrate-playwright-utils.md +813 -0
- package/docs/how-to/customization/shard-large-documents.md +101 -0
- package/docs/how-to/get-answers-about-bmad.md +102 -0
- package/docs/how-to/installation/index.md +12 -0
- package/docs/how-to/installation/install-bmad.md +111 -0
- package/docs/how-to/installation/install-custom-modules.md +118 -0
- package/docs/how-to/installation/upgrade-to-v6.md +131 -0
- package/docs/how-to/workflows/bmgd-quick-flow.md +156 -0
- package/docs/how-to/workflows/conduct-research.md +97 -0
- package/docs/how-to/workflows/create-architecture.md +119 -0
- package/docs/how-to/workflows/create-epics-and-stories.md +109 -0
- package/docs/how-to/workflows/create-prd.md +91 -0
- package/docs/how-to/workflows/create-product-brief.md +94 -0
- package/docs/how-to/workflows/create-story.md +102 -0
- package/docs/how-to/workflows/create-ux-design.md +100 -0
- package/docs/how-to/workflows/implement-story.md +97 -0
- package/docs/how-to/workflows/quick-spec.md +122 -0
- package/docs/how-to/workflows/run-atdd.md +436 -0
- package/docs/how-to/workflows/run-automate.md +653 -0
- package/docs/how-to/workflows/run-brainstorming-session.md +73 -0
- package/docs/how-to/workflows/run-code-review.md +89 -0
- package/docs/how-to/workflows/run-implementation-readiness.md +125 -0
- package/docs/how-to/workflows/run-nfr-assess.md +679 -0
- package/docs/how-to/workflows/run-sprint-planning.md +94 -0
- package/docs/how-to/workflows/run-test-design.md +98 -0
- package/docs/how-to/workflows/run-test-review.md +605 -0
- package/docs/how-to/workflows/run-trace.md +883 -0
- package/docs/how-to/workflows/setup-ci.md +712 -0
- package/docs/how-to/workflows/setup-party-mode.md +89 -0
- package/docs/how-to/workflows/setup-test-framework.md +98 -0
- package/docs/index.md +63 -0
- package/docs/migration-guide.md +365 -0
- package/docs/multi-scope-guide.md +379 -0
- package/docs/plans/multi-scope-parallel-artifacts-plan.md +695 -0
- package/docs/reference/agents/index.md +109 -0
- package/docs/reference/configuration/core-tasks.md +67 -0
- package/docs/reference/configuration/global-config.md +28 -0
- package/docs/reference/glossary/index.md +159 -0
- package/docs/reference/tea/commands.md +254 -0
- package/docs/reference/tea/configuration.md +678 -0
- package/docs/reference/tea/knowledge-base.md +340 -0
- package/docs/reference/workflows/core-workflows.md +32 -0
- package/docs/reference/workflows/document-project.md +73 -0
- package/docs/reference/workflows/index.md +12 -0
- package/docs/tutorials/getting-started/getting-started-bmadv6.md +246 -0
- package/docs/tutorials/getting-started/images/workflow-method-greenfield.excalidraw +5034 -0
- package/docs/tutorials/getting-started/images/workflow-method-greenfield.svg +4 -0
- package/docs/tutorials/getting-started/images/workflow-overview.jpg +0 -0
- package/docs/tutorials/getting-started/tea-lite-quickstart.md +444 -0
- package/docs/tutorials/getting-started/workflow-overview.jpg +0 -0
- package/eslint.config.mjs +152 -0
- package/package.json +117 -0
- package/prettier.config.mjs +32 -0
- package/src/bmm/_module-installer/installer.js +48 -0
- package/src/bmm/_module-installer/platform-specifics/claude-code.js +35 -0
- package/src/bmm/_module-installer/platform-specifics/windsurf.js +32 -0
- package/src/bmm/agents/analyst.agent.yaml +41 -0
- package/src/bmm/agents/architect.agent.yaml +33 -0
- package/src/bmm/agents/dev.agent.yaml +38 -0
- package/src/bmm/agents/pm.agent.yaml +51 -0
- package/src/bmm/agents/quick-flow-solo-dev.agent.yaml +32 -0
- package/src/bmm/agents/sm.agent.yaml +47 -0
- package/src/bmm/agents/tea.agent.yaml +68 -0
- package/src/bmm/agents/tech-writer/tech-writer-sidecar/documentation-standards.md +224 -0
- package/src/bmm/agents/tech-writer/tech-writer.agent.yaml +49 -0
- package/src/bmm/agents/ux-designer.agent.yaml +30 -0
- package/src/bmm/data/README.md +29 -0
- package/src/bmm/data/project-context-template.md +40 -0
- package/src/bmm/module.yaml +64 -0
- package/src/bmm/sub-modules/claude-code/config.yaml +4 -0
- package/src/bmm/sub-modules/claude-code/injections.yaml +242 -0
- package/src/bmm/sub-modules/claude-code/readme.md +87 -0
- package/src/bmm/teams/default-party.csv +21 -0
- package/src/bmm/teams/team-fullstack.yaml +12 -0
- package/src/bmm/testarch/knowledge/api-request.md +442 -0
- package/src/bmm/testarch/knowledge/api-testing-patterns.md +843 -0
- package/src/bmm/testarch/knowledge/auth-session.md +552 -0
- package/src/bmm/testarch/knowledge/burn-in.md +273 -0
- package/src/bmm/testarch/knowledge/ci-burn-in.md +675 -0
- package/src/bmm/testarch/knowledge/component-tdd.md +486 -0
- package/src/bmm/testarch/knowledge/contract-testing.md +957 -0
- package/src/bmm/testarch/knowledge/data-factories.md +500 -0
- package/src/bmm/testarch/knowledge/email-auth.md +721 -0
- package/src/bmm/testarch/knowledge/error-handling.md +725 -0
- package/src/bmm/testarch/knowledge/feature-flags.md +750 -0
- package/src/bmm/testarch/knowledge/file-utils.md +463 -0
- package/src/bmm/testarch/knowledge/fixture-architecture.md +401 -0
- package/src/bmm/testarch/knowledge/fixtures-composition.md +382 -0
- package/src/bmm/testarch/knowledge/intercept-network-call.md +430 -0
- package/src/bmm/testarch/knowledge/log.md +429 -0
- package/src/bmm/testarch/knowledge/network-error-monitor.md +405 -0
- package/src/bmm/testarch/knowledge/network-first.md +486 -0
- package/src/bmm/testarch/knowledge/network-recorder.md +527 -0
- package/src/bmm/testarch/knowledge/nfr-criteria.md +670 -0
- package/src/bmm/testarch/knowledge/overview.md +286 -0
- package/src/bmm/testarch/knowledge/playwright-config.md +730 -0
- package/src/bmm/testarch/knowledge/probability-impact.md +601 -0
- package/src/bmm/testarch/knowledge/recurse.md +421 -0
- package/src/bmm/testarch/knowledge/risk-governance.md +615 -0
- package/src/bmm/testarch/knowledge/selective-testing.md +732 -0
- package/src/bmm/testarch/knowledge/selector-resilience.md +527 -0
- package/src/bmm/testarch/knowledge/test-healing-patterns.md +644 -0
- package/src/bmm/testarch/knowledge/test-levels-framework.md +473 -0
- package/src/bmm/testarch/knowledge/test-priorities-matrix.md +373 -0
- package/src/bmm/testarch/knowledge/test-quality.md +664 -0
- package/src/bmm/testarch/knowledge/timing-debugging.md +372 -0
- package/src/bmm/testarch/knowledge/visual-debugging.md +524 -0
- package/src/bmm/testarch/tea-index.csv +34 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +177 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +161 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +199 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +202 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +205 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +219 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +194 -0
- package/src/bmm/workflows/1-analysis/create-product-brief/workflow.md +58 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -0
- package/src/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +443 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +200 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -0
- package/src/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +475 -0
- package/src/bmm/workflows/1-analysis/research/research.template.md +29 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +239 -0
- package/src/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +486 -0
- package/src/bmm/workflows/1-analysis/research/workflow.md +173 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +248 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +228 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -0
- package/src/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +43 -0
- package/src/bmm/workflows/2-plan-workflows/prd/data/domain-complexity.csv +13 -0
- package/src/bmm/workflows/2-plan-workflows/prd/data/prd-purpose.md +197 -0
- package/src/bmm/workflows/2-plan-workflows/prd/data/project-types.csv +11 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-01-init.md +191 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-01b-continue.md +153 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-02-discovery.md +224 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-03-success.md +226 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-04-journeys.md +213 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-05-domain.md +207 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-06-innovation.md +226 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-07-project-type.md +237 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-08-scoping.md +228 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-09-functional.md +231 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-10-nonfunctional.md +242 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-11-polish.md +217 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-c/step-12-complete.md +180 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01-discovery.md +247 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-01b-legacy-conversion.md +208 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-02-review.md +249 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-03-edit.md +253 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-e/step-e-04-complete.md +168 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-01-discovery.md +218 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02-format-detection.md +191 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-02b-parity-check.md +209 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-03-density-validation.md +174 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-04-brief-coverage-validation.md +214 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-05-measurability-validation.md +228 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-06-traceability-validation.md +217 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-07-implementation-leakage-validation.md +205 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-08-domain-compliance-validation.md +243 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-09-project-type-validation.md +263 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-10-smart-validation.md +209 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-11-holistic-quality-validation.md +264 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-12-completeness-validation.md +242 -0
- package/src/bmm/workflows/2-plan-workflows/prd/steps-v/step-v-13-report-complete.md +232 -0
- package/src/bmm/workflows/2-plan-workflows/prd/templates/prd-template.md +10 -0
- package/src/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md +433 -0
- package/src/bmm/workflows/2-plan-workflows/prd/workflow.md +150 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +190 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +178 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +179 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +139 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +252 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +133 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -0
- package/src/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +55 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +11 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +7 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +153 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +164 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +331 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +318 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +359 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +359 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +352 -0
- package/src/bmm/workflows/3-solutioning/create-architecture/workflow.md +50 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +145 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -0
- package/src/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +59 -0
- package/src/bmm/workflows/4-implementation/code-review/checklist.md +23 -0
- package/src/bmm/workflows/4-implementation/code-review/instructions.xml +227 -0
- package/src/bmm/workflows/4-implementation/code-review/workflow.yaml +51 -0
- package/src/bmm/workflows/4-implementation/correct-course/checklist.md +288 -0
- package/src/bmm/workflows/4-implementation/correct-course/instructions.md +206 -0
- package/src/bmm/workflows/4-implementation/correct-course/workflow.yaml +60 -0
- package/src/bmm/workflows/4-implementation/create-story/checklist.md +358 -0
- package/src/bmm/workflows/4-implementation/create-story/instructions.xml +345 -0
- package/src/bmm/workflows/4-implementation/create-story/template.md +49 -0
- package/src/bmm/workflows/4-implementation/create-story/workflow.yaml +61 -0
- package/src/bmm/workflows/4-implementation/dev-story/checklist.md +80 -0
- package/src/bmm/workflows/4-implementation/dev-story/instructions.xml +410 -0
- package/src/bmm/workflows/4-implementation/dev-story/workflow.yaml +27 -0
- package/src/bmm/workflows/4-implementation/retrospective/instructions.md +1443 -0
- package/src/bmm/workflows/4-implementation/retrospective/workflow.yaml +58 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/instructions.md +225 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -0
- package/src/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +54 -0
- package/src/bmm/workflows/4-implementation/sprint-status/instructions.md +229 -0
- package/src/bmm/workflows/4-implementation/sprint-status/workflow.yaml +36 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +156 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +120 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +113 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +113 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +106 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +140 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +52 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +189 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +144 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +128 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +191 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md +74 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +79 -0
- package/src/bmm/workflows/document-project/checklist.md +245 -0
- package/src/bmm/workflows/document-project/documentation-requirements.csv +12 -0
- package/src/bmm/workflows/document-project/instructions.md +221 -0
- package/src/bmm/workflows/document-project/templates/deep-dive-template.md +345 -0
- package/src/bmm/workflows/document-project/templates/index-template.md +169 -0
- package/src/bmm/workflows/document-project/templates/project-overview-template.md +103 -0
- package/src/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -0
- package/src/bmm/workflows/document-project/templates/source-tree-template.md +135 -0
- package/src/bmm/workflows/document-project/workflow.yaml +30 -0
- package/src/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -0
- package/src/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -0
- package/src/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -0
- package/src/bmm/workflows/document-project/workflows/full-scan.yaml +31 -0
- package/src/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json +90 -0
- package/src/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml +127 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md +39 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +130 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml +27 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md +43 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +141 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml +27 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md +49 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +241 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml +27 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md +38 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +133 -0
- package/src/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml +27 -0
- package/src/bmm/workflows/generate-project-context/project-context-template.md +21 -0
- package/src/bmm/workflows/generate-project-context/steps/step-01-discover.md +184 -0
- package/src/bmm/workflows/generate-project-context/steps/step-02-generate.md +318 -0
- package/src/bmm/workflows/generate-project-context/steps/step-03-complete.md +278 -0
- package/src/bmm/workflows/generate-project-context/workflow.md +49 -0
- package/src/bmm/workflows/testarch/atdd/atdd-checklist-template.md +364 -0
- package/src/bmm/workflows/testarch/atdd/checklist.md +374 -0
- package/src/bmm/workflows/testarch/atdd/instructions.md +806 -0
- package/src/bmm/workflows/testarch/atdd/workflow.yaml +47 -0
- package/src/bmm/workflows/testarch/automate/checklist.md +582 -0
- package/src/bmm/workflows/testarch/automate/instructions.md +1324 -0
- package/src/bmm/workflows/testarch/automate/workflow.yaml +54 -0
- package/src/bmm/workflows/testarch/ci/checklist.md +248 -0
- package/src/bmm/workflows/testarch/ci/github-actions-template.yaml +198 -0
- package/src/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +149 -0
- package/src/bmm/workflows/testarch/ci/instructions.md +536 -0
- package/src/bmm/workflows/testarch/ci/workflow.yaml +47 -0
- package/src/bmm/workflows/testarch/framework/checklist.md +321 -0
- package/src/bmm/workflows/testarch/framework/instructions.md +481 -0
- package/src/bmm/workflows/testarch/framework/workflow.yaml +49 -0
- package/src/bmm/workflows/testarch/nfr-assess/checklist.md +407 -0
- package/src/bmm/workflows/testarch/nfr-assess/instructions.md +722 -0
- package/src/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +445 -0
- package/src/bmm/workflows/testarch/nfr-assess/workflow.yaml +49 -0
- package/src/bmm/workflows/testarch/test-design/checklist.md +235 -0
- package/src/bmm/workflows/testarch/test-design/instructions.md +788 -0
- package/src/bmm/workflows/testarch/test-design/test-design-template.md +294 -0
- package/src/bmm/workflows/testarch/test-design/workflow.yaml +56 -0
- package/src/bmm/workflows/testarch/test-review/checklist.md +472 -0
- package/src/bmm/workflows/testarch/test-review/instructions.md +628 -0
- package/src/bmm/workflows/testarch/test-review/test-review-template.md +390 -0
- package/src/bmm/workflows/testarch/test-review/workflow.yaml +48 -0
- package/src/bmm/workflows/testarch/trace/checklist.md +655 -0
- package/src/bmm/workflows/testarch/trace/instructions.md +1047 -0
- package/src/bmm/workflows/testarch/trace/trace-template.md +675 -0
- package/src/bmm/workflows/testarch/trace/workflow.yaml +57 -0
- package/src/bmm/workflows/workflow-status/init/instructions.md +346 -0
- package/src/bmm/workflows/workflow-status/init/workflow.yaml +30 -0
- package/src/bmm/workflows/workflow-status/instructions.md +397 -0
- package/src/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +103 -0
- package/src/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +100 -0
- package/src/bmm/workflows/workflow-status/paths/method-brownfield.yaml +103 -0
- package/src/bmm/workflows/workflow-status/paths/method-greenfield.yaml +100 -0
- package/src/bmm/workflows/workflow-status/project-levels.yaml +59 -0
- package/src/bmm/workflows/workflow-status/workflow-status-template.yaml +24 -0
- package/src/bmm/workflows/workflow-status/workflow.yaml +32 -0
- package/src/core/_module-installer/installer.js +60 -0
- package/src/core/agents/bmad-master.agent.yaml +30 -0
- package/src/core/lib/scope/artifact-resolver.js +298 -0
- package/src/core/lib/scope/event-logger.js +400 -0
- package/src/core/lib/scope/index.js +30 -0
- package/src/core/lib/scope/scope-context.js +301 -0
- package/src/core/lib/scope/scope-initializer.js +456 -0
- package/src/core/lib/scope/scope-manager.js +512 -0
- package/src/core/lib/scope/scope-migrator.js +434 -0
- package/src/core/lib/scope/scope-sync.js +483 -0
- package/src/core/lib/scope/scope-validator.js +294 -0
- package/src/core/lib/scope/state-lock.js +336 -0
- package/src/core/module.yaml +53 -0
- package/src/core/resources/excalidraw/README.md +160 -0
- package/src/core/resources/excalidraw/excalidraw-helpers.md +127 -0
- package/src/core/resources/excalidraw/library-loader.md +50 -0
- package/src/core/resources/excalidraw/validate-json-instructions.md +79 -0
- package/src/core/tasks/editorial-review-prose.xml +91 -0
- package/src/core/tasks/editorial-review-structure.xml +198 -0
- package/src/core/tasks/index-docs.xml +65 -0
- package/src/core/tasks/review-adversarial-general.xml +46 -0
- package/src/core/tasks/shard-doc.xml +109 -0
- package/src/core/tasks/workflow.xml +277 -0
- package/src/core/workflows/advanced-elicitation/methods.csv +51 -0
- package/src/core/workflows/advanced-elicitation/workflow.xml +117 -0
- package/src/core/workflows/brainstorming/brain-methods.csv +62 -0
- package/src/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -0
- package/src/core/workflows/brainstorming/steps/step-01b-continue.md +122 -0
- package/src/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -0
- package/src/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -0
- package/src/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -0
- package/src/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -0
- package/src/core/workflows/brainstorming/steps/step-03-technique-execution.md +399 -0
- package/src/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -0
- package/src/core/workflows/brainstorming/template.md +15 -0
- package/src/core/workflows/brainstorming/workflow.md +58 -0
- package/src/core/workflows/party-mode/steps/step-01-agent-loading.md +138 -0
- package/src/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +187 -0
- package/src/core/workflows/party-mode/steps/step-03-graceful-exit.md +157 -0
- package/src/core/workflows/party-mode/workflow.md +194 -0
- package/src/utility/agent-components/activation-rules.txt +6 -0
- package/src/utility/agent-components/activation-steps.txt +28 -0
- package/src/utility/agent-components/agent-command-header.md +1 -0
- package/src/utility/agent-components/agent.customize.template.yaml +41 -0
- package/src/utility/agent-components/handler-action.txt +4 -0
- package/src/utility/agent-components/handler-data.txt +5 -0
- package/src/utility/agent-components/handler-exec.txt +19 -0
- package/src/utility/agent-components/handler-multi.txt +14 -0
- package/src/utility/agent-components/handler-tmpl.txt +5 -0
- package/src/utility/agent-components/handler-validate-workflow.txt +7 -0
- package/src/utility/agent-components/handler-workflow.txt +10 -0
- package/src/utility/agent-components/menu-handlers.txt +6 -0
- package/test/README.md +295 -0
- package/test/fixtures/agent-schema/invalid/critical-actions/actions-as-string.agent.yaml +27 -0
- package/test/fixtures/agent-schema/invalid/critical-actions/empty-string-in-actions.agent.yaml +30 -0
- package/test/fixtures/agent-schema/invalid/menu/empty-menu.agent.yaml +22 -0
- package/test/fixtures/agent-schema/invalid/menu/missing-menu.agent.yaml +20 -0
- package/test/fixtures/agent-schema/invalid/menu-commands/empty-command-target.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-commands/no-command-target.agent.yaml +24 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/camel-case.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/compound-invalid-format.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/compound-mismatched-kebab.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/duplicate-triggers.agent.yaml +31 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/empty-trigger.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/leading-asterisk.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/snake-case.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/menu-triggers/trigger-with-spaces.agent.yaml +25 -0
- package/test/fixtures/agent-schema/invalid/metadata/empty-module-string.agent.yaml +26 -0
- package/test/fixtures/agent-schema/invalid/metadata/empty-name.agent.yaml +24 -0
- package/test/fixtures/agent-schema/invalid/metadata/extra-metadata-fields.agent.yaml +27 -0
- package/test/fixtures/agent-schema/invalid/metadata/missing-id.agent.yaml +23 -0
- package/test/fixtures/agent-schema/invalid/persona/empty-principles-array.agent.yaml +24 -0
- package/test/fixtures/agent-schema/invalid/persona/empty-string-in-principles.agent.yaml +27 -0
- package/test/fixtures/agent-schema/invalid/persona/extra-persona-fields.agent.yaml +27 -0
- package/test/fixtures/agent-schema/invalid/persona/missing-role.agent.yaml +24 -0
- package/test/fixtures/agent-schema/invalid/prompts/empty-content.agent.yaml +29 -0
- package/test/fixtures/agent-schema/invalid/prompts/extra-prompt-fields.agent.yaml +31 -0
- package/test/fixtures/agent-schema/invalid/prompts/missing-content.agent.yaml +28 -0
- package/test/fixtures/agent-schema/invalid/prompts/missing-id.agent.yaml +28 -0
- package/test/fixtures/agent-schema/invalid/top-level/empty-file.agent.yaml +5 -0
- package/test/fixtures/agent-schema/invalid/top-level/extra-top-level-keys.agent.yaml +28 -0
- package/test/fixtures/agent-schema/invalid/top-level/missing-agent-key.agent.yaml +11 -0
- package/test/fixtures/agent-schema/invalid/yaml-errors/invalid-indentation.agent.yaml +19 -0
- package/test/fixtures/agent-schema/invalid/yaml-errors/malformed-yaml.agent.yaml +18 -0
- package/test/fixtures/agent-schema/valid/critical-actions/empty-critical-actions.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/critical-actions/no-critical-actions.agent.yaml +22 -0
- package/test/fixtures/agent-schema/valid/critical-actions/valid-critical-actions.agent.yaml +27 -0
- package/test/fixtures/agent-schema/valid/menu/multiple-menu-items.agent.yaml +31 -0
- package/test/fixtures/agent-schema/valid/menu/single-menu-item.agent.yaml +22 -0
- package/test/fixtures/agent-schema/valid/menu-commands/all-command-types.agent.yaml +38 -0
- package/test/fixtures/agent-schema/valid/menu-commands/multiple-commands.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/menu-triggers/compound-triggers.agent.yaml +31 -0
- package/test/fixtures/agent-schema/valid/menu-triggers/kebab-case-triggers.agent.yaml +34 -0
- package/test/fixtures/agent-schema/valid/metadata/core-agent-with-module.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/metadata/empty-module-name-in-path.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/metadata/malformed-path-treated-as-core.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/metadata/module-agent-correct.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/metadata/module-agent-missing-module.agent.yaml +23 -0
- package/test/fixtures/agent-schema/valid/metadata/wrong-module-value.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/persona/complete-persona.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/prompts/empty-prompts.agent.yaml +24 -0
- package/test/fixtures/agent-schema/valid/prompts/no-prompts.agent.yaml +22 -0
- package/test/fixtures/agent-schema/valid/prompts/valid-prompts-minimal.agent.yaml +28 -0
- package/test/fixtures/agent-schema/valid/prompts/valid-prompts-with-description.agent.yaml +30 -0
- package/test/fixtures/agent-schema/valid/top-level/minimal-core-agent.agent.yaml +24 -0
- package/test/test-agent-schema.js +387 -0
- package/test/test-cli-integration.sh +159 -0
- package/test/test-installation-components.js +214 -0
- package/test/test-scope-e2e.js +439 -0
- package/test/test-scope-system.js +781 -0
- package/test/unit-test-schema.js +133 -0
- package/tools/bmad-npx-wrapper.js +38 -0
- package/tools/build-docs.js +577 -0
- package/tools/cli/README.md +7 -0
- package/tools/cli/bmad-cli.js +58 -0
- package/tools/cli/commands/install.js +87 -0
- package/tools/cli/commands/scope.js +474 -0
- package/tools/cli/external-official-modules.yaml +41 -0
- package/tools/cli/installers/install-messages.yaml +58 -0
- package/tools/cli/installers/lib/core/config-collector.js +1079 -0
- package/tools/cli/installers/lib/core/custom-module-cache.js +259 -0
- package/tools/cli/installers/lib/core/dependency-resolver.js +739 -0
- package/tools/cli/installers/lib/core/detector.js +223 -0
- package/tools/cli/installers/lib/core/ide-config-manager.js +156 -0
- package/tools/cli/installers/lib/core/installer.js +2585 -0
- package/tools/cli/installers/lib/core/manifest-generator.js +963 -0
- package/tools/cli/installers/lib/core/manifest.js +590 -0
- package/tools/cli/installers/lib/custom/handler.js +363 -0
- package/tools/cli/installers/lib/ide/_base-ide.js +654 -0
- package/tools/cli/installers/lib/ide/antigravity.js +486 -0
- package/tools/cli/installers/lib/ide/auggie.js +244 -0
- package/tools/cli/installers/lib/ide/claude-code.js +487 -0
- package/tools/cli/installers/lib/ide/cline.js +269 -0
- package/tools/cli/installers/lib/ide/codex.js +375 -0
- package/tools/cli/installers/lib/ide/crush.js +300 -0
- package/tools/cli/installers/lib/ide/cursor.js +169 -0
- package/tools/cli/installers/lib/ide/gemini.js +301 -0
- package/tools/cli/installers/lib/ide/github-copilot.js +383 -0
- package/tools/cli/installers/lib/ide/iflow.js +191 -0
- package/tools/cli/installers/lib/ide/kilo.js +250 -0
- package/tools/cli/installers/lib/ide/kiro-cli.js +326 -0
- package/tools/cli/installers/lib/ide/manager.js +244 -0
- package/tools/cli/installers/lib/ide/opencode.js +257 -0
- package/tools/cli/installers/lib/ide/qwen.js +372 -0
- package/tools/cli/installers/lib/ide/roo.js +270 -0
- package/tools/cli/installers/lib/ide/rovo-dev.js +290 -0
- package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +96 -0
- package/tools/cli/installers/lib/ide/shared/bmad-artifacts.js +158 -0
- package/tools/cli/installers/lib/ide/shared/module-injections.js +136 -0
- package/tools/cli/installers/lib/ide/shared/task-tool-command-generator.js +119 -0
- package/tools/cli/installers/lib/ide/shared/workflow-command-generator.js +242 -0
- package/tools/cli/installers/lib/ide/templates/agent-command-template.md +29 -0
- package/tools/cli/installers/lib/ide/templates/gemini-agent-command.toml +14 -0
- package/tools/cli/installers/lib/ide/templates/gemini-task-command.toml +12 -0
- package/tools/cli/installers/lib/ide/templates/workflow-command-template.md +30 -0
- package/tools/cli/installers/lib/ide/templates/workflow-commander.md +45 -0
- package/tools/cli/installers/lib/ide/trae.js +313 -0
- package/tools/cli/installers/lib/ide/windsurf.js +258 -0
- package/tools/cli/installers/lib/message-loader.js +85 -0
- package/tools/cli/installers/lib/modules/external-manager.js +133 -0
- package/tools/cli/installers/lib/modules/manager.js +1362 -0
- package/tools/cli/lib/activation-builder.js +163 -0
- package/tools/cli/lib/agent/compiler.js +522 -0
- package/tools/cli/lib/agent/installer.js +716 -0
- package/tools/cli/lib/agent/template-engine.js +152 -0
- package/tools/cli/lib/agent-analyzer.js +109 -0
- package/tools/cli/lib/agent-party-generator.js +194 -0
- package/tools/cli/lib/cli-utils.js +227 -0
- package/tools/cli/lib/config.js +213 -0
- package/tools/cli/lib/file-ops.js +204 -0
- package/tools/cli/lib/platform-codes.js +116 -0
- package/tools/cli/lib/project-root.js +77 -0
- package/tools/cli/lib/prompts.js +433 -0
- package/tools/cli/lib/ui.js +1591 -0
- package/tools/cli/lib/xml-handler.js +177 -0
- package/tools/cli/lib/xml-to-markdown.js +82 -0
- package/tools/cli/lib/yaml-format.js +245 -0
- package/tools/cli/lib/yaml-xml-builder.js +587 -0
- package/tools/cli/scripts/migrate-workflows.js +273 -0
- package/tools/docs/BUNDLE_DISTRIBUTION_SETUP.md +95 -0
- package/tools/docs/index.md +2 -0
- package/tools/fix-doc-links.js +288 -0
- package/tools/flattener/aggregate.js +76 -0
- package/tools/flattener/binary.js +80 -0
- package/tools/flattener/discovery.js +71 -0
- package/tools/flattener/files.js +35 -0
- package/tools/flattener/ignoreRules.js +172 -0
- package/tools/flattener/main.js +483 -0
- package/tools/flattener/projectRoot.js +201 -0
- package/tools/flattener/prompts.js +44 -0
- package/tools/flattener/stats.helpers.js +368 -0
- package/tools/flattener/stats.js +75 -0
- package/tools/flattener/test-matrix.js +409 -0
- package/tools/flattener/xml.js +82 -0
- package/tools/format-workflow-md.js +263 -0
- package/tools/lib/xml-utils.js +13 -0
- package/tools/maintainer/review-pr-README.md +55 -0
- package/tools/maintainer/review-pr.md +242 -0
- package/tools/migrate-custom-module-paths.js +124 -0
- package/tools/platform-codes.yaml +157 -0
- package/tools/schema/agent.js +493 -0
- package/tools/validate-agent-schema.js +110 -0
- package/tools/validate-doc-links.js +363 -0
- package/tools/validate-svg-changes.sh +356 -0
- package/website/README.md +76 -0
- package/website/astro.config.mjs +228 -0
- package/website/public/favicon.ico +0 -0
- package/website/public/img/bmad-dark.png +0 -0
- package/website/public/img/bmad-light.png +0 -0
- package/website/public/img/logo.svg +4 -0
- package/website/public/robots.txt +37 -0
- package/website/src/components/Banner.astro +59 -0
- package/website/src/components/Header.astro +121 -0
- package/website/src/components/MobileMenuFooter.astro +53 -0
- package/website/src/content/config.ts +6 -0
- package/website/src/lib/site-url.js +25 -0
- package/website/src/rehype-markdown-links.js +102 -0
- package/website/src/styles/custom.css +485 -0
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Agents Reference"
|
|
3
|
+
description: Complete reference for BMad Method agents and their commands
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
Quick reference of all BMad Method agents and their available commands.
|
|
7
|
+
|
|
8
|
+
:::tip[Universal Commands]
|
|
9
|
+
All agents support: `*menu` (redisplay options), `*dismiss` (dismiss agent), and `*party-mode` (multi-agent collaboration).
|
|
10
|
+
:::
|
|
11
|
+
|
|
12
|
+
## Analyst (Mary)
|
|
13
|
+
|
|
14
|
+
Business analysis and research.
|
|
15
|
+
|
|
16
|
+
**Commands:**
|
|
17
|
+
- `*workflow-status` — Get workflow status or initialize tracking
|
|
18
|
+
- `*brainstorm-project` — Guided brainstorming session
|
|
19
|
+
- `*research` — Market, domain, competitive, or technical research
|
|
20
|
+
- `*product-brief` — Create a product brief (input for PRD)
|
|
21
|
+
- `*document-project` — Document existing brownfield projects
|
|
22
|
+
|
|
23
|
+
## PM (John)
|
|
24
|
+
|
|
25
|
+
Product requirements and planning.
|
|
26
|
+
|
|
27
|
+
**Commands:**
|
|
28
|
+
- `*workflow-status` — Get workflow status or initialize tracking
|
|
29
|
+
- `*create-prd` — Create Product Requirements Document
|
|
30
|
+
- `*create-epics-and-stories` — Break PRD into epics and user stories (after Architecture)
|
|
31
|
+
- `*implementation-readiness` — Validate PRD, UX, Architecture, Epics alignment
|
|
32
|
+
- `*correct-course` — Course correction during implementation
|
|
33
|
+
|
|
34
|
+
## Architect (Winston)
|
|
35
|
+
|
|
36
|
+
System architecture and technical design.
|
|
37
|
+
|
|
38
|
+
**Commands:**
|
|
39
|
+
- `*workflow-status` — Get workflow status or initialize tracking
|
|
40
|
+
- `*create-architecture` — Create architecture document to guide development
|
|
41
|
+
- `*implementation-readiness` — Validate PRD, UX, Architecture, Epics alignment
|
|
42
|
+
- `*create-excalidraw-diagram` — System architecture or technical diagrams
|
|
43
|
+
- `*create-excalidraw-dataflow` — Data flow diagrams
|
|
44
|
+
|
|
45
|
+
## SM (Bob)
|
|
46
|
+
|
|
47
|
+
Sprint planning and story preparation.
|
|
48
|
+
|
|
49
|
+
**Commands:**
|
|
50
|
+
- `*sprint-planning` — Generate sprint-status.yaml from epic files
|
|
51
|
+
- `*create-story` — Create story from epic (prep for development)
|
|
52
|
+
- `*validate-create-story` — Validate story quality
|
|
53
|
+
- `*epic-retrospective` — Team retrospective after epic completion
|
|
54
|
+
- `*correct-course` — Course correction during implementation
|
|
55
|
+
|
|
56
|
+
## DEV (Amelia)
|
|
57
|
+
|
|
58
|
+
Story implementation and code review.
|
|
59
|
+
|
|
60
|
+
**Commands:**
|
|
61
|
+
- `*dev-story` — Execute story workflow (implementation with tests)
|
|
62
|
+
- `*code-review` — Thorough code review
|
|
63
|
+
|
|
64
|
+
## Quick Flow Solo Dev (Barry)
|
|
65
|
+
|
|
66
|
+
Fast solo development without handoffs.
|
|
67
|
+
|
|
68
|
+
**Commands:**
|
|
69
|
+
- `*quick-spec` — Architect technical spec with implementation-ready stories
|
|
70
|
+
- `*quick-dev` — Implement tech spec end-to-end solo
|
|
71
|
+
- `*code-review` — Review and improve code
|
|
72
|
+
|
|
73
|
+
## TEA (Murat)
|
|
74
|
+
|
|
75
|
+
Test architecture and quality strategy.
|
|
76
|
+
|
|
77
|
+
**Commands:**
|
|
78
|
+
- `*framework` — Initialize production-ready test framework
|
|
79
|
+
- `*atdd` — Generate E2E tests first (before implementation)
|
|
80
|
+
- `*automate` — Comprehensive test automation
|
|
81
|
+
- `*test-design` — Create comprehensive test scenarios
|
|
82
|
+
- `*trace` — Map requirements to tests, quality gate decision
|
|
83
|
+
- `*nfr-assess` — Validate non-functional requirements
|
|
84
|
+
- `*ci` — Scaffold CI/CD quality pipeline
|
|
85
|
+
- `*test-review` — Review test quality
|
|
86
|
+
|
|
87
|
+
## UX Designer (Sally)
|
|
88
|
+
|
|
89
|
+
User experience and UI design.
|
|
90
|
+
|
|
91
|
+
**Commands:**
|
|
92
|
+
- `*create-ux-design` — Generate UX design and UI plan from PRD
|
|
93
|
+
- `*validate-design` — Validate UX specification and design artifacts
|
|
94
|
+
- `*create-excalidraw-wireframe` — Create website or app wireframe
|
|
95
|
+
|
|
96
|
+
## Technical Writer (Paige)
|
|
97
|
+
|
|
98
|
+
Technical documentation and diagrams.
|
|
99
|
+
|
|
100
|
+
**Commands:**
|
|
101
|
+
- `*document-project` — Comprehensive project documentation
|
|
102
|
+
- `*generate-mermaid` — Generate Mermaid diagrams
|
|
103
|
+
- `*create-excalidraw-flowchart` — Process and logic flow visualizations
|
|
104
|
+
- `*create-excalidraw-diagram` — System architecture or technical diagrams
|
|
105
|
+
- `*create-excalidraw-dataflow` — Data flow visualizations
|
|
106
|
+
- `*validate-doc` — Review documentation against standards
|
|
107
|
+
- `*improve-readme` — Review and improve README files
|
|
108
|
+
- `*explain-concept` — Create clear technical explanations
|
|
109
|
+
- `*standards-guide` — Show BMad documentation standards
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Core Tasks"
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
Reusable task definitions that can be invoked by any BMad module, workflow, or agent.
|
|
6
|
+
|
|
7
|
+
## Contents
|
|
8
|
+
|
|
9
|
+
- [Index Docs](#index-docs) — Generate directory index files
|
|
10
|
+
- [Adversarial Review](#adversarial-review) — Critical content review
|
|
11
|
+
- [Shard Document](#shard-document) — Split large documents into sections
|
|
12
|
+
|
|
13
|
+
## Index Docs
|
|
14
|
+
|
|
15
|
+
**Generates or updates an index.md file documenting all files in a specified directory.**
|
|
16
|
+
|
|
17
|
+
**Use it when:**
|
|
18
|
+
- You need navigable documentation for a folder of markdown files
|
|
19
|
+
- You want to maintain an updated index as content evolves
|
|
20
|
+
|
|
21
|
+
**How it works:**
|
|
22
|
+
1. Scan the target directory for files and subdirectories
|
|
23
|
+
2. Group content by type, purpose, or location
|
|
24
|
+
3. Read each file to generate brief (3-10 word) descriptions
|
|
25
|
+
4. Create or update index.md with organized listings
|
|
26
|
+
|
|
27
|
+
**Output:** Markdown index with sections for Files and Subdirectories, each entry containing a relative link and description.
|
|
28
|
+
|
|
29
|
+
## Adversarial Review
|
|
30
|
+
|
|
31
|
+
**Performs a cynical, skeptical review of any content to identify issues and improvement opportunities.**
|
|
32
|
+
|
|
33
|
+
**Use it when:**
|
|
34
|
+
- Reviewing code diffs before merging
|
|
35
|
+
- Finalizing specifications or user stories
|
|
36
|
+
- Releasing documentation
|
|
37
|
+
- Any artifact needs a critical eye before completion
|
|
38
|
+
|
|
39
|
+
**How it works:**
|
|
40
|
+
1. Load the content to review (diff, branch, document, etc.)
|
|
41
|
+
2. Perform adversarial analysis — assume problems exist
|
|
42
|
+
3. Find at least ten issues to fix or improve
|
|
43
|
+
4. Output findings as a markdown list
|
|
44
|
+
|
|
45
|
+
:::note[Unbiased Review]
|
|
46
|
+
This task runs in a separate subagent with read access but no prior context, ensuring an unbiased review.
|
|
47
|
+
:::
|
|
48
|
+
|
|
49
|
+
## Shard Document
|
|
50
|
+
|
|
51
|
+
**Splits large markdown documents into smaller files based on level 2 (`##`) sections.**
|
|
52
|
+
|
|
53
|
+
**Use it when:**
|
|
54
|
+
- A markdown file has grown too large to work with effectively
|
|
55
|
+
- You want to break a monolithic document into manageable sections
|
|
56
|
+
- Individual sections need to be edited independently
|
|
57
|
+
|
|
58
|
+
**How it works:**
|
|
59
|
+
1. Confirm source document path (must be markdown)
|
|
60
|
+
2. Determine destination folder (defaults to folder named after document)
|
|
61
|
+
3. Execute sharding via `npx @kayvan/markdown-tree-parser`
|
|
62
|
+
4. Verify output files and index.md were created
|
|
63
|
+
5. Handle original document — delete, move to archive, or keep
|
|
64
|
+
|
|
65
|
+
:::caution[Original File]
|
|
66
|
+
After sharding, delete or archive the original to avoid confusion. Updates should happen in the sharded files only.
|
|
67
|
+
:::
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Global Inheritable Config"
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
Configuration values defined in the Core Module that all other modules inherit by default.
|
|
6
|
+
|
|
7
|
+
## Core Config Values
|
|
8
|
+
|
|
9
|
+
These values are set during installation and recorded to the core `module.yaml`:
|
|
10
|
+
|
|
11
|
+
| Config Key | Default | Description |
|
|
12
|
+
|------------|---------|-------------|
|
|
13
|
+
| `user_name` | System username | User's display name |
|
|
14
|
+
| `communication_language` | `english` | Language for agent communication |
|
|
15
|
+
| `document_output_language` | `english` | Language for generated documents |
|
|
16
|
+
| `output_folder` | `_bmad-output` | Directory for workflow outputs |
|
|
17
|
+
|
|
18
|
+
## Inheritance Behavior
|
|
19
|
+
|
|
20
|
+
All installed modules automatically clone these values into their own config. Modules can:
|
|
21
|
+
|
|
22
|
+
- **Accept defaults** — Use core values as-is (recommended)
|
|
23
|
+
- **Override values** — Replace with module-specific settings
|
|
24
|
+
- **Extend values** — Build on core values with additional paths
|
|
25
|
+
|
|
26
|
+
:::tip[Extending Config]
|
|
27
|
+
Use `{output_folder}` to reference the core value. Example: BMad Method defines `planning_artifacts` as `{output_folder}/planning-artifacts`, automatically inheriting whatever output folder the user configured.
|
|
28
|
+
:::
|
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "BMad Glossary"
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
Terminology reference for the BMad Method.
|
|
6
|
+
|
|
7
|
+
## Core Concepts
|
|
8
|
+
|
|
9
|
+
| Term | Definition |
|
|
10
|
+
| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
11
|
+
| **Agent** | Specialized AI persona with specific expertise (PM, Architect, SM, DEV, TEA) that guides users through workflows and creates deliverables. |
|
|
12
|
+
| **BMad** | Breakthrough Method of Agile AI-Driven Development — AI-driven agile framework with specialized agents, guided workflows, and scale-adaptive intelligence. |
|
|
13
|
+
| **BMad Method** | Complete methodology for AI-assisted software development, encompassing planning, architecture, implementation, and quality assurance workflows that adapt to project complexity. |
|
|
14
|
+
| **BMM** | BMad Method Module — core orchestration system providing comprehensive lifecycle management through specialized agents and workflows. |
|
|
15
|
+
| **Scale-Adaptive System** | Intelligent workflow orchestration that adjusts planning depth and documentation requirements based on project needs through three planning tracks. |
|
|
16
|
+
| **Workflow** | Multi-step guided process that orchestrates AI agent activities to produce specific deliverables. Workflows are interactive and adapt to user context. |
|
|
17
|
+
|
|
18
|
+
## Scale and Complexity
|
|
19
|
+
|
|
20
|
+
| Term | Definition |
|
|
21
|
+
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
22
|
+
| **BMad Method Track** | Full product planning track using PRD + Architecture + UX. Best for products, platforms, and complex features. Typical range: 10-50+ stories. |
|
|
23
|
+
| **Enterprise Method Track** | Extended planning track adding Security Architecture, DevOps Strategy, and Test Strategy. Best for compliance needs and multi-tenant systems. Typical range: 30+ stories. |
|
|
24
|
+
| **Planning Track** | Methodology path (Quick Flow, BMad Method, or Enterprise) chosen based on planning needs and complexity, not story count alone. |
|
|
25
|
+
| **Quick Flow Track** | Fast implementation track using tech-spec only. Best for bug fixes, small features, and clear-scope changes. Typical range: 1-15 stories. |
|
|
26
|
+
|
|
27
|
+
## Planning Documents
|
|
28
|
+
|
|
29
|
+
| Term | Definition |
|
|
30
|
+
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
31
|
+
| **Architecture Document** | *BMad Method/Enterprise.* System-wide design document defining structure, components, data models, integration patterns, security, and deployment. |
|
|
32
|
+
| **Epics** | High-level feature groupings containing multiple related stories. Typically 5-15 stories each representing cohesive functionality. |
|
|
33
|
+
| **Game Brief** | *BMGD.* Document capturing game's core vision, pillars, target audience, and scope. Foundation for the GDD. |
|
|
34
|
+
| **GDD** | *BMGD.* Game Design Document — comprehensive document detailing all aspects of game design: mechanics, systems, content, and more. |
|
|
35
|
+
| **PRD** | *BMad Method/Enterprise.* Product Requirements Document containing vision, goals, FRs, NFRs, and success criteria. Focuses on WHAT to build. |
|
|
36
|
+
| **Product Brief** | *Phase 1.* Optional strategic document capturing product vision, market context, and high-level requirements before detailed planning. |
|
|
37
|
+
| **Tech-Spec** | *Quick Flow only.* Comprehensive technical plan with problem statement, solution approach, file-level changes, and testing strategy. |
|
|
38
|
+
|
|
39
|
+
## Workflow and Phases
|
|
40
|
+
|
|
41
|
+
| Term | Definition |
|
|
42
|
+
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
43
|
+
| **Phase 0: Documentation** | *Brownfield.* Conditional prerequisite phase creating codebase documentation before planning. Only required if existing docs are insufficient. |
|
|
44
|
+
| **Phase 1: Analysis** | Discovery phase including brainstorming, research, and product brief creation. Optional for Quick Flow, recommended for BMad Method. |
|
|
45
|
+
| **Phase 2: Planning** | Required phase creating formal requirements. Routes to tech-spec (Quick Flow) or PRD (BMad Method/Enterprise). |
|
|
46
|
+
| **Phase 3: Solutioning** | *BMad Method/Enterprise.* Architecture design phase including creation, validation, and gate checks. |
|
|
47
|
+
| **Phase 4: Implementation** | Required sprint-based development through story-by-story iteration using sprint-planning, create-story, dev-story, and code-review workflows. |
|
|
48
|
+
| **Quick Spec Flow** | Fast-track workflow for Quick Flow projects going straight from idea to tech-spec to implementation. |
|
|
49
|
+
| **Workflow Init** | Initialization workflow creating bmm-workflow-status.yaml, detecting project type, and determining planning track. |
|
|
50
|
+
| **Workflow Status** | Universal entry point checking for existing status file, displaying progress, and recommending next action. |
|
|
51
|
+
|
|
52
|
+
## Agents and Roles
|
|
53
|
+
|
|
54
|
+
| Term | Definition |
|
|
55
|
+
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
56
|
+
| **Analyst** | Agent that initializes workflows, conducts research, creates product briefs, and tracks progress. Often the entry point for new projects. |
|
|
57
|
+
| **Architect** | Agent designing system architecture, creating architecture documents, and validating designs. Primary agent for Phase 3. |
|
|
58
|
+
| **BMad Master** | Meta-level orchestrator from BMad Core facilitating party mode and providing high-level guidance across all modules. |
|
|
59
|
+
| **DEV** | Developer agent implementing stories, writing code, running tests, and performing code reviews. Primary implementer in Phase 4. |
|
|
60
|
+
| **Game Architect** | *BMGD.* Agent designing game system architecture and validating game-specific technical designs. |
|
|
61
|
+
| **Game Designer** | *BMGD.* Agent creating game design documents (GDD) and running game-specific workflows. |
|
|
62
|
+
| **Party Mode** | Multi-agent collaboration feature where agents discuss challenges together. BMad Master orchestrates, selecting 2-3 relevant agents per message. |
|
|
63
|
+
| **PM** | Product Manager agent creating PRDs and tech-specs. Primary agent for Phase 2 planning. |
|
|
64
|
+
| **SM** | Scrum Master agent managing sprints, creating stories, and coordinating implementation. Primary orchestrator for Phase 4. |
|
|
65
|
+
| **TEA** | Test Architect agent responsible for test strategy, quality gates, and NFR assessment. Integrates throughout all phases. |
|
|
66
|
+
| **Technical Writer** | Agent specialized in creating technical documentation, diagrams, and maintaining documentation standards. |
|
|
67
|
+
| **UX Designer** | Agent creating UX design documents, interaction patterns, and visual specifications for UI-heavy projects. |
|
|
68
|
+
|
|
69
|
+
## Status and Tracking
|
|
70
|
+
|
|
71
|
+
| Term | Definition |
|
|
72
|
+
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
|
73
|
+
| **bmm-workflow-status.yaml** | *Phases 1-3.* Tracking file showing current phase, completed workflows, and next recommended actions. |
|
|
74
|
+
| **DoD** | Definition of Done — criteria for marking a story complete: implementation done, tests passing, code reviewed, docs updated. |
|
|
75
|
+
| **Epic Status Progression** | `backlog → in-progress → done` — lifecycle states for epics during implementation. |
|
|
76
|
+
| **Gate Check** | Validation workflow (implementation-readiness) ensuring PRD, Architecture, and Epics are aligned before Phase 4. |
|
|
77
|
+
| **Retrospective** | Workflow after each epic capturing learnings and improvements for continuous improvement. |
|
|
78
|
+
| **sprint-status.yaml** | *Phase 4.* Single source of truth for implementation tracking containing all epics, stories, and their statuses. |
|
|
79
|
+
| **Story Status Progression** | `backlog → ready-for-dev → in-progress → review → done` — lifecycle states for stories. |
|
|
80
|
+
|
|
81
|
+
## Project Types
|
|
82
|
+
|
|
83
|
+
| Term | Definition |
|
|
84
|
+
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------- |
|
|
85
|
+
| **Brownfield** | Existing project with established codebase and patterns. Requires understanding existing architecture and planning integration. |
|
|
86
|
+
| **Convention Detection** | *Quick Flow.* Feature auto-detecting existing code style, naming conventions, and frameworks from brownfield codebases. |
|
|
87
|
+
| **document-project** | *Brownfield.* Workflow analyzing and documenting existing codebase with three scan levels: quick, deep, exhaustive. |
|
|
88
|
+
| **Feature Flags** | *Brownfield.* Implementation technique for gradual rollout, easy rollback, and A/B testing of new functionality. |
|
|
89
|
+
| **Greenfield** | New project starting from scratch with freedom to establish patterns, choose stack, and design from clean slate. |
|
|
90
|
+
| **Integration Points** | *Brownfield.* Specific locations where new code connects with existing systems. Must be documented in tech-specs. |
|
|
91
|
+
|
|
92
|
+
## Implementation Terms
|
|
93
|
+
|
|
94
|
+
| Term | Definition |
|
|
95
|
+
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
96
|
+
| **Context Engineering** | Loading domain-specific standards into AI context automatically via manifests, ensuring consistent outputs regardless of prompt variation. |
|
|
97
|
+
| **Correct Course** | Workflow for navigating significant changes when implementation is off-track. Analyzes impact and recommends adjustments. |
|
|
98
|
+
| **Shard / Sharding** | Splitting large planning documents into section-based files for LLM optimization. Phase 4 workflows load only needed sections. |
|
|
99
|
+
| **Sprint** | Time-boxed period of development work, typically 1-2 weeks. |
|
|
100
|
+
| **Sprint Planning** | Workflow initializing Phase 4 by creating sprint-status.yaml and extracting epics/stories from planning docs. |
|
|
101
|
+
| **Story** | Single unit of implementable work with clear acceptance criteria, typically 2-8 hours of effort. Grouped into epics. |
|
|
102
|
+
| **Story Context** | Implementation guidance embedded in story files during create-story, referencing existing patterns and approaches. |
|
|
103
|
+
| **Story File** | Markdown file containing story description, acceptance criteria, technical notes, and testing requirements. |
|
|
104
|
+
| **Track Selection** | Automatic analysis by workflow-init suggesting appropriate track based on complexity indicators. User can override. |
|
|
105
|
+
|
|
106
|
+
## Game Development Terms
|
|
107
|
+
|
|
108
|
+
| Term | Definition |
|
|
109
|
+
| ------------------------------ | ---------------------------------------------------------------------------------------------------- |
|
|
110
|
+
| **Core Fantasy** | *BMGD.* The emotional experience players seek from your game — what they want to FEEL. |
|
|
111
|
+
| **Core Loop** | *BMGD.* Fundamental cycle of actions players repeat throughout gameplay. The heart of your game. |
|
|
112
|
+
| **Design Pillar** | *BMGD.* Core principle guiding all design decisions. Typically 3-5 pillars define a game's identity. |
|
|
113
|
+
| **Environmental Storytelling** | *BMGD.* Narrative communicated through the game world itself rather than explicit dialogue. |
|
|
114
|
+
| **Game Type** | *BMGD.* Genre classification determining which specialized GDD sections are included. |
|
|
115
|
+
| **MDA Framework** | *BMGD.* Mechanics → Dynamics → Aesthetics — framework for analyzing and designing games. |
|
|
116
|
+
| **Meta-Progression** | *BMGD.* Persistent progression carrying between individual runs or sessions. |
|
|
117
|
+
| **Metroidvania** | *BMGD.* Genre featuring interconnected world exploration with ability-gated progression. |
|
|
118
|
+
| **Narrative Complexity** | *BMGD.* How central story is to the game: Critical, Heavy, Moderate, or Light. |
|
|
119
|
+
| **Permadeath** | *BMGD.* Game mechanic where character death is permanent, typically requiring a new run. |
|
|
120
|
+
| **Player Agency** | *BMGD.* Degree to which players can make meaningful choices affecting outcomes. |
|
|
121
|
+
| **Procedural Generation** | *BMGD.* Algorithmic creation of game content (levels, items, characters) rather than hand-crafted. |
|
|
122
|
+
| **Roguelike** | *BMGD.* Genre featuring procedural generation, permadeath, and run-based progression. |
|
|
123
|
+
|
|
124
|
+
## Test Architect (TEA) Concepts
|
|
125
|
+
|
|
126
|
+
| Term | Definition |
|
|
127
|
+
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
128
|
+
| **ATDD** | Acceptance Test-Driven Development — Generating failing acceptance tests BEFORE implementation (TDD red phase). |
|
|
129
|
+
| **Burn-in Testing** | Running tests multiple times (typically 5-10 iterations) to detect flakiness and intermittent failures. |
|
|
130
|
+
| **Component Testing** | Testing UI components in isolation using framework-specific tools (Cypress Component Testing or Vitest + React Testing Library). |
|
|
131
|
+
| **Coverage Traceability** | Mapping acceptance criteria to implemented tests with classification (FULL/PARTIAL/NONE) to identify gaps and measure completeness. |
|
|
132
|
+
| **Epic-Level Test Design** | Test planning per epic (Phase 4) focusing on risk assessment, priorities, and coverage strategy for that specific epic. |
|
|
133
|
+
| **Fixture Architecture** | Pattern of building pure functions first, then wrapping in framework-specific fixtures for testability, reusability, and composition. |
|
|
134
|
+
| **Gate Decision** | Go/no-go decision for release with four outcomes: PASS ✅ (ready), CONCERNS ⚠️ (proceed with mitigation), FAIL ❌ (blocked), WAIVED ⏭️ (approved despite issues). |
|
|
135
|
+
| **Knowledge Fragment** | Individual markdown file in TEA's knowledge base covering a specific testing pattern or practice (33 fragments total). |
|
|
136
|
+
| **MCP Enhancements** | Model Context Protocol servers enabling live browser verification during test generation (exploratory, recording, and healing modes). |
|
|
137
|
+
| **Network-First Pattern** | Testing pattern that waits for actual network responses instead of fixed timeouts to avoid race conditions and flakiness. |
|
|
138
|
+
| **NFR Assessment** | Validation of non-functional requirements (security, performance, reliability, maintainability) with evidence-based decisions. |
|
|
139
|
+
| **Playwright Utils** | Optional package (`@seontechnologies/playwright-utils`) providing production-ready fixtures and utilities for Playwright tests. |
|
|
140
|
+
| **Risk-Based Testing** | Testing approach where depth scales with business impact using probability × impact scoring (1-9 scale). |
|
|
141
|
+
| **System-Level Test Design** | Test planning at architecture level (Phase 3) focusing on testability review, ADR mapping, and test infrastructure needs. |
|
|
142
|
+
| **tea-index.csv** | Manifest file tracking all knowledge fragments, their descriptions, tags, and which workflows load them. |
|
|
143
|
+
| **TEA Integrated** | Full BMad Method integration with TEA workflows across all phases (Phase 2, 3, 4, and Release Gate). |
|
|
144
|
+
| **TEA Lite** | Beginner approach using just `*automate` workflow to test existing features (simplest way to use TEA). |
|
|
145
|
+
| **TEA Solo** | Standalone engagement model using TEA without full BMad Method integration (bring your own requirements). |
|
|
146
|
+
| **Test Priorities** | Classification system for test importance: P0 (critical path), P1 (high value), P2 (medium value), P3 (low value). |
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
## See Also
|
|
151
|
+
|
|
152
|
+
- [TEA Overview](/docs/explanation/features/tea-overview.md) - Complete TEA capabilities
|
|
153
|
+
- [TEA Knowledge Base](/docs/reference/tea/knowledge-base.md) - Fragment index
|
|
154
|
+
- [TEA Command Reference](/docs/reference/tea/commands.md) - Workflow reference
|
|
155
|
+
- [TEA Configuration](/docs/reference/tea/configuration.md) - Config options
|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
Generated with [BMad Method](https://bmad-method.org)
|
|
@@ -0,0 +1,254 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "TEA Command Reference"
|
|
3
|
+
description: Quick reference for all 8 TEA workflows - inputs, outputs, and links to detailed guides
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# TEA Command Reference
|
|
7
|
+
|
|
8
|
+
Quick reference for all 8 TEA (Test Architect) workflows. For detailed step-by-step guides, see the how-to documentation.
|
|
9
|
+
|
|
10
|
+
## Quick Index
|
|
11
|
+
|
|
12
|
+
- [*framework](#framework) - Scaffold test framework
|
|
13
|
+
- [*ci](#ci) - Setup CI/CD pipeline
|
|
14
|
+
- [*test-design](#test-design) - Risk-based test planning
|
|
15
|
+
- [*atdd](#atdd) - Acceptance TDD
|
|
16
|
+
- [*automate](#automate) - Test automation
|
|
17
|
+
- [*test-review](#test-review) - Quality audit
|
|
18
|
+
- [*nfr-assess](#nfr-assess) - NFR assessment
|
|
19
|
+
- [*trace](#trace) - Coverage traceability
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## *framework
|
|
24
|
+
|
|
25
|
+
**Purpose:** Scaffold production-ready test framework (Playwright or Cypress)
|
|
26
|
+
|
|
27
|
+
**Phase:** Phase 3 (Solutioning)
|
|
28
|
+
|
|
29
|
+
**Frequency:** Once per project
|
|
30
|
+
|
|
31
|
+
**Key Inputs:**
|
|
32
|
+
- Tech stack, test framework choice, testing scope
|
|
33
|
+
|
|
34
|
+
**Key Outputs:**
|
|
35
|
+
- `tests/` directory with `support/fixtures/` and `support/helpers/`
|
|
36
|
+
- `playwright.config.ts` or `cypress.config.ts`
|
|
37
|
+
- `.env.example`, `.nvmrc`
|
|
38
|
+
- Sample tests with best practices
|
|
39
|
+
|
|
40
|
+
**How-To Guide:** [Setup Test Framework](/docs/how-to/workflows/setup-test-framework.md)
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## *ci
|
|
45
|
+
|
|
46
|
+
**Purpose:** Setup CI/CD pipeline with selective testing and burn-in
|
|
47
|
+
|
|
48
|
+
**Phase:** Phase 3 (Solutioning)
|
|
49
|
+
|
|
50
|
+
**Frequency:** Once per project
|
|
51
|
+
|
|
52
|
+
**Key Inputs:**
|
|
53
|
+
- CI platform (GitHub Actions, GitLab CI, etc.)
|
|
54
|
+
- Sharding strategy, burn-in preferences
|
|
55
|
+
|
|
56
|
+
**Key Outputs:**
|
|
57
|
+
- Platform-specific CI workflow (`.github/workflows/test.yml`, etc.)
|
|
58
|
+
- Parallel execution configuration
|
|
59
|
+
- Burn-in loops for flakiness detection
|
|
60
|
+
- Secrets checklist
|
|
61
|
+
|
|
62
|
+
**How-To Guide:** [Setup CI Pipeline](/docs/how-to/workflows/setup-ci.md)
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
## *test-design
|
|
67
|
+
|
|
68
|
+
**Purpose:** Risk-based test planning with coverage strategy
|
|
69
|
+
|
|
70
|
+
**Phase:** Phase 3 (system-level), Phase 4 (epic-level)
|
|
71
|
+
|
|
72
|
+
**Frequency:** Once (system), per epic (epic-level)
|
|
73
|
+
|
|
74
|
+
**Modes:**
|
|
75
|
+
- **System-level:** Architecture testability review
|
|
76
|
+
- **Epic-level:** Per-epic risk assessment
|
|
77
|
+
|
|
78
|
+
**Key Inputs:**
|
|
79
|
+
- Architecture/epic, requirements, ADRs
|
|
80
|
+
|
|
81
|
+
**Key Outputs:**
|
|
82
|
+
- `test-design-system.md` or `test-design-epic-N.md`
|
|
83
|
+
- Risk assessment (probability × impact scores)
|
|
84
|
+
- Test priorities (P0-P3)
|
|
85
|
+
- Coverage strategy
|
|
86
|
+
|
|
87
|
+
**MCP Enhancement:** Exploratory mode (live browser UI discovery)
|
|
88
|
+
|
|
89
|
+
**How-To Guide:** [Run Test Design](/docs/how-to/workflows/run-test-design.md)
|
|
90
|
+
|
|
91
|
+
---
|
|
92
|
+
|
|
93
|
+
## *atdd
|
|
94
|
+
|
|
95
|
+
**Purpose:** Generate failing acceptance tests BEFORE implementation (TDD red phase)
|
|
96
|
+
|
|
97
|
+
**Phase:** Phase 4 (Implementation)
|
|
98
|
+
|
|
99
|
+
**Frequency:** Per story (optional)
|
|
100
|
+
|
|
101
|
+
**Key Inputs:**
|
|
102
|
+
- Story with acceptance criteria, test design, test levels
|
|
103
|
+
|
|
104
|
+
**Key Outputs:**
|
|
105
|
+
- Failing tests (`tests/api/`, `tests/e2e/`)
|
|
106
|
+
- Implementation checklist
|
|
107
|
+
- All tests fail initially (red phase)
|
|
108
|
+
|
|
109
|
+
**MCP Enhancement:** Recording mode (for skeleton UI only - rare)
|
|
110
|
+
|
|
111
|
+
**How-To Guide:** [Run ATDD](/docs/how-to/workflows/run-atdd.md)
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## *automate
|
|
116
|
+
|
|
117
|
+
**Purpose:** Expand test coverage after implementation
|
|
118
|
+
|
|
119
|
+
**Phase:** Phase 4 (Implementation)
|
|
120
|
+
|
|
121
|
+
**Frequency:** Per story/feature
|
|
122
|
+
|
|
123
|
+
**Key Inputs:**
|
|
124
|
+
- Feature description, test design, existing tests to avoid duplication
|
|
125
|
+
|
|
126
|
+
**Key Outputs:**
|
|
127
|
+
- Comprehensive test suite (`tests/e2e/`, `tests/api/`)
|
|
128
|
+
- Updated fixtures, README
|
|
129
|
+
- Definition of Done summary
|
|
130
|
+
|
|
131
|
+
**MCP Enhancement:** Healing + Recording modes (fix tests, verify selectors)
|
|
132
|
+
|
|
133
|
+
**How-To Guide:** [Run Automate](/docs/how-to/workflows/run-automate.md)
|
|
134
|
+
|
|
135
|
+
---
|
|
136
|
+
|
|
137
|
+
## *test-review
|
|
138
|
+
|
|
139
|
+
**Purpose:** Audit test quality with 0-100 scoring
|
|
140
|
+
|
|
141
|
+
**Phase:** Phase 4 (optional per story), Release Gate
|
|
142
|
+
|
|
143
|
+
**Frequency:** Per epic or before release
|
|
144
|
+
|
|
145
|
+
**Key Inputs:**
|
|
146
|
+
- Test scope (file, directory, or entire suite)
|
|
147
|
+
|
|
148
|
+
**Key Outputs:**
|
|
149
|
+
- `test-review.md` with quality score (0-100)
|
|
150
|
+
- Critical issues with fixes
|
|
151
|
+
- Recommendations
|
|
152
|
+
- Category scores (Determinism, Isolation, Assertions, Structure, Performance)
|
|
153
|
+
|
|
154
|
+
**Scoring Categories:**
|
|
155
|
+
- Determinism: 35 points
|
|
156
|
+
- Isolation: 25 points
|
|
157
|
+
- Assertions: 20 points
|
|
158
|
+
- Structure: 10 points
|
|
159
|
+
- Performance: 10 points
|
|
160
|
+
|
|
161
|
+
**How-To Guide:** [Run Test Review](/docs/how-to/workflows/run-test-review.md)
|
|
162
|
+
|
|
163
|
+
---
|
|
164
|
+
|
|
165
|
+
## *nfr-assess
|
|
166
|
+
|
|
167
|
+
**Purpose:** Validate non-functional requirements with evidence
|
|
168
|
+
|
|
169
|
+
**Phase:** Phase 2 (enterprise), Release Gate
|
|
170
|
+
|
|
171
|
+
**Frequency:** Per release (enterprise projects)
|
|
172
|
+
|
|
173
|
+
**Key Inputs:**
|
|
174
|
+
- NFR categories (Security, Performance, Reliability, Maintainability)
|
|
175
|
+
- Thresholds, evidence location
|
|
176
|
+
|
|
177
|
+
**Key Outputs:**
|
|
178
|
+
- `nfr-assessment.md`
|
|
179
|
+
- Category assessments (PASS/CONCERNS/FAIL)
|
|
180
|
+
- Mitigation plans
|
|
181
|
+
- Gate decision inputs
|
|
182
|
+
|
|
183
|
+
**How-To Guide:** [Run NFR Assessment](/docs/how-to/workflows/run-nfr-assess.md)
|
|
184
|
+
|
|
185
|
+
---
|
|
186
|
+
|
|
187
|
+
## *trace
|
|
188
|
+
|
|
189
|
+
**Purpose:** Requirements traceability + quality gate decision
|
|
190
|
+
|
|
191
|
+
**Phase:** Phase 2/4 (traceability), Release Gate (decision)
|
|
192
|
+
|
|
193
|
+
**Frequency:** Baseline, per epic refresh, release gate
|
|
194
|
+
|
|
195
|
+
**Two-Phase Workflow:**
|
|
196
|
+
|
|
197
|
+
**Phase 1: Traceability**
|
|
198
|
+
- Requirements → test mapping
|
|
199
|
+
- Coverage classification (FULL/PARTIAL/NONE)
|
|
200
|
+
- Gap prioritization
|
|
201
|
+
- Output: `traceability-matrix.md`
|
|
202
|
+
|
|
203
|
+
**Phase 2: Gate Decision**
|
|
204
|
+
- PASS/CONCERNS/FAIL/WAIVED decision
|
|
205
|
+
- Evidence-based (coverage %, quality scores, NFRs)
|
|
206
|
+
- Output: `gate-decision-{gate_type}-{story_id}.md`
|
|
207
|
+
|
|
208
|
+
**Gate Rules:**
|
|
209
|
+
- P0 coverage: 100% required
|
|
210
|
+
- P1 coverage: ≥90% for PASS, 80-89% for CONCERNS, <80% FAIL
|
|
211
|
+
- Overall coverage: ≥80% required
|
|
212
|
+
|
|
213
|
+
**How-To Guide:** [Run Trace](/docs/how-to/workflows/run-trace.md)
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
## Summary Table
|
|
218
|
+
|
|
219
|
+
| Command | Phase | Frequency | Primary Output |
|
|
220
|
+
|---------|-------|-----------|----------------|
|
|
221
|
+
| `*framework` | 3 | Once | Test infrastructure |
|
|
222
|
+
| `*ci` | 3 | Once | CI/CD pipeline |
|
|
223
|
+
| `*test-design` | 3, 4 | System + per epic | Test design doc |
|
|
224
|
+
| `*atdd` | 4 | Per story (optional) | Failing tests |
|
|
225
|
+
| `*automate` | 4 | Per story | Passing tests |
|
|
226
|
+
| `*test-review` | 4, Gate | Per epic/release | Quality report |
|
|
227
|
+
| `*nfr-assess` | 2, Gate | Per release | NFR assessment |
|
|
228
|
+
| `*trace` | 2, 4, Gate | Baseline + refresh + gate | Coverage matrix + decision |
|
|
229
|
+
|
|
230
|
+
---
|
|
231
|
+
|
|
232
|
+
## See Also
|
|
233
|
+
|
|
234
|
+
**How-To Guides (Detailed Instructions):**
|
|
235
|
+
- [Setup Test Framework](/docs/how-to/workflows/setup-test-framework.md)
|
|
236
|
+
- [Setup CI Pipeline](/docs/how-to/workflows/setup-ci.md)
|
|
237
|
+
- [Run Test Design](/docs/how-to/workflows/run-test-design.md)
|
|
238
|
+
- [Run ATDD](/docs/how-to/workflows/run-atdd.md)
|
|
239
|
+
- [Run Automate](/docs/how-to/workflows/run-automate.md)
|
|
240
|
+
- [Run Test Review](/docs/how-to/workflows/run-test-review.md)
|
|
241
|
+
- [Run NFR Assessment](/docs/how-to/workflows/run-nfr-assess.md)
|
|
242
|
+
- [Run Trace](/docs/how-to/workflows/run-trace.md)
|
|
243
|
+
|
|
244
|
+
**Explanation:**
|
|
245
|
+
- [TEA Overview](/docs/explanation/features/tea-overview.md) - Complete TEA lifecycle
|
|
246
|
+
- [Engagement Models](/docs/explanation/tea/engagement-models.md) - When to use which workflows
|
|
247
|
+
|
|
248
|
+
**Reference:**
|
|
249
|
+
- [TEA Configuration](/docs/reference/tea/configuration.md) - Config options
|
|
250
|
+
- [Knowledge Base Index](/docs/reference/tea/knowledge-base.md) - Pattern fragments
|
|
251
|
+
|
|
252
|
+
---
|
|
253
|
+
|
|
254
|
+
Generated with [BMad Method](https://bmad-method.org) - TEA (Test Architect)
|