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
package/CNAME
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
docs.bmad-method.org
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,306 @@
|
|
|
1
|
+
# Contributing to BMad
|
|
2
|
+
|
|
3
|
+
Thank you for considering contributing! We believe in **Human Amplification, Not Replacement** — bringing out the best thinking in both humans and AI through guided collaboration.
|
|
4
|
+
|
|
5
|
+
💬 **Discord**: [Join our community](https://discord.gg/gk8jAdXWmj) for real-time discussions, questions, and collaboration.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Our Philosophy
|
|
10
|
+
|
|
11
|
+
BMad strengthens human-AI collaboration through specialized agents and guided workflows. Every contribution should answer: **"Does this make humans and AI better together?"**
|
|
12
|
+
|
|
13
|
+
**✅ What we welcome:**
|
|
14
|
+
- Enhanced collaboration patterns and workflows
|
|
15
|
+
- Improved agent personas and prompts
|
|
16
|
+
- Domain-specific modules leveraging BMad Core
|
|
17
|
+
- Better planning and context continuity
|
|
18
|
+
|
|
19
|
+
**❌ What doesn't fit:**
|
|
20
|
+
- Purely automated solutions that sideline humans
|
|
21
|
+
- Complexity that creates barriers to adoption
|
|
22
|
+
- Features that fragment BMad Core's foundation
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Reporting Issues
|
|
27
|
+
|
|
28
|
+
**ALL bug reports and feature requests MUST go through GitHub Issues.**
|
|
29
|
+
|
|
30
|
+
### Before Creating an Issue
|
|
31
|
+
|
|
32
|
+
1. **Search existing issues** — Use the GitHub issue search to check if your bug or feature has already been reported
|
|
33
|
+
2. **Search closed issues** — Your issue may have been fixed or addressed previously
|
|
34
|
+
3. **Check discussions** — Some conversations happen in [GitHub Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions)
|
|
35
|
+
|
|
36
|
+
### Bug Reports
|
|
37
|
+
|
|
38
|
+
After searching, if the bug is unreported, use the [bug report template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=bug_report.md) and include:
|
|
39
|
+
|
|
40
|
+
- Clear description of the problem
|
|
41
|
+
- Steps to reproduce
|
|
42
|
+
- Expected vs actual behavior
|
|
43
|
+
- Your environment (model, IDE, BMad version)
|
|
44
|
+
- Screenshots or error messages if applicable
|
|
45
|
+
|
|
46
|
+
### Feature Requests
|
|
47
|
+
|
|
48
|
+
After searching, use the [feature request template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=feature_request.md) and explain:
|
|
49
|
+
|
|
50
|
+
- What the feature is
|
|
51
|
+
- Why it would benefit the BMad community
|
|
52
|
+
- How it strengthens human-AI collaboration
|
|
53
|
+
|
|
54
|
+
**For community modules**, review [TRADEMARK.md](TRADEMARK.md) for proper naming conventions (e.g., "My Module (BMad Community Module)").
|
|
55
|
+
|
|
56
|
+
---
|
|
57
|
+
|
|
58
|
+
## Before Starting Work
|
|
59
|
+
|
|
60
|
+
⚠️ **Required before submitting PRs:**
|
|
61
|
+
|
|
62
|
+
| Work Type | Requirement |
|
|
63
|
+
| ------------- | ---------------------------------------------- |
|
|
64
|
+
| Bug fix | An open issue (create one if it doesn't exist) |
|
|
65
|
+
| Feature | An open feature request issue |
|
|
66
|
+
| Large changes | Discussion via issue first |
|
|
67
|
+
|
|
68
|
+
**Why?** This prevents wasted effort on work that may not align with project direction.
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## Pull Request Guidelines
|
|
73
|
+
|
|
74
|
+
### Target Branch
|
|
75
|
+
|
|
76
|
+
Submit PRs to the `main` branch.
|
|
77
|
+
|
|
78
|
+
### PR Size
|
|
79
|
+
|
|
80
|
+
- **Ideal**: 200-400 lines of code changes
|
|
81
|
+
- **Maximum**: 800 lines (excluding generated files)
|
|
82
|
+
- **One feature/fix per PR**
|
|
83
|
+
|
|
84
|
+
If your change exceeds 800 lines, break it into smaller PRs that can be reviewed independently.
|
|
85
|
+
|
|
86
|
+
### New to Pull Requests?
|
|
87
|
+
|
|
88
|
+
1. **Fork** the repository
|
|
89
|
+
2. **Clone** your fork: `git clone https://github.com/YOUR-USERNAME/bmad-method.git`
|
|
90
|
+
3. **Create a branch**: `git checkout -b fix/description` or `git checkout -b feature/description`
|
|
91
|
+
4. **Make changes** — keep them focused
|
|
92
|
+
5. **Commit**: `git commit -m "fix: correct typo in README"`
|
|
93
|
+
6. **Push**: `git push origin fix/description`
|
|
94
|
+
7. **Open PR** from your fork on GitHub
|
|
95
|
+
|
|
96
|
+
### PR Description Template
|
|
97
|
+
|
|
98
|
+
```markdown
|
|
99
|
+
## What
|
|
100
|
+
[1-2 sentences describing WHAT changed]
|
|
101
|
+
|
|
102
|
+
## Why
|
|
103
|
+
[1-2 sentences explaining WHY this change is needed]
|
|
104
|
+
Fixes #[issue number]
|
|
105
|
+
|
|
106
|
+
## How
|
|
107
|
+
- [2-3 bullets listing HOW you implemented it]
|
|
108
|
+
-
|
|
109
|
+
|
|
110
|
+
## Testing
|
|
111
|
+
[1-2 sentences on how you tested this]
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
**Keep it under 200 words.**
|
|
115
|
+
|
|
116
|
+
### Commit Messages
|
|
117
|
+
|
|
118
|
+
Use conventional commits:
|
|
119
|
+
|
|
120
|
+
- `feat:` New feature
|
|
121
|
+
- `fix:` Bug fix
|
|
122
|
+
- `docs:` Documentation only
|
|
123
|
+
- `refactor:` Code change (no bug/feature)
|
|
124
|
+
- `test:` Adding tests
|
|
125
|
+
- `chore:` Build/tools changes
|
|
126
|
+
|
|
127
|
+
Keep messages under 72 characters. Each commit = one logical change.
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
## Git Workflow for Contributors
|
|
132
|
+
|
|
133
|
+
### One-Time Setup
|
|
134
|
+
|
|
135
|
+
After forking and cloning the repository, set up your development environment:
|
|
136
|
+
|
|
137
|
+
```bash
|
|
138
|
+
# 1. Add the upstream remote (main repository)
|
|
139
|
+
git remote add upstream git@github.com:bmad-code-org/BMAD-METHOD.git
|
|
140
|
+
|
|
141
|
+
# 2. Enable git hooks (enforces workflow automatically)
|
|
142
|
+
git config core.hooksPath .githooks
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### Single-Commit Workflow
|
|
146
|
+
|
|
147
|
+
**This repository uses a single-commit-per-branch workflow** to keep PR history clean.
|
|
148
|
+
|
|
149
|
+
#### Initial Development
|
|
150
|
+
|
|
151
|
+
```bash
|
|
152
|
+
# Create feature branch
|
|
153
|
+
git checkout -b feat/your-feature
|
|
154
|
+
|
|
155
|
+
# Make your changes
|
|
156
|
+
# ... edit files ...
|
|
157
|
+
|
|
158
|
+
# Commit once
|
|
159
|
+
git commit -m "feat: add your feature description"
|
|
160
|
+
|
|
161
|
+
# Push to your fork
|
|
162
|
+
git push -u origin feat/your-feature
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
#### Making Additional Changes
|
|
166
|
+
|
|
167
|
+
**Use amend instead of creating new commits:**
|
|
168
|
+
|
|
169
|
+
```bash
|
|
170
|
+
# Make more changes
|
|
171
|
+
# ... edit files ...
|
|
172
|
+
|
|
173
|
+
# Stage changes
|
|
174
|
+
git add .
|
|
175
|
+
|
|
176
|
+
# Amend the existing commit
|
|
177
|
+
git commit --amend --no-edit
|
|
178
|
+
|
|
179
|
+
# Force push (safely)
|
|
180
|
+
git push --force-with-lease
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
#### Addressing PR Feedback
|
|
184
|
+
|
|
185
|
+
```bash
|
|
186
|
+
# Make requested changes
|
|
187
|
+
# ... edit files ...
|
|
188
|
+
|
|
189
|
+
# Amend (don't create new commits)
|
|
190
|
+
git commit --amend --no-edit
|
|
191
|
+
|
|
192
|
+
# Force push
|
|
193
|
+
git push --force-with-lease
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
### Keeping Your Branch Updated
|
|
197
|
+
|
|
198
|
+
```bash
|
|
199
|
+
# Sync your local main with upstream
|
|
200
|
+
git checkout main
|
|
201
|
+
git pull upstream main
|
|
202
|
+
|
|
203
|
+
# Rebase your feature branch
|
|
204
|
+
git checkout feat/your-feature
|
|
205
|
+
git rebase main
|
|
206
|
+
|
|
207
|
+
# Force push (safely)
|
|
208
|
+
git push --force-with-lease
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### What the Git Hooks Do
|
|
212
|
+
|
|
213
|
+
The hooks in `.githooks/` automate workflow enforcement:
|
|
214
|
+
|
|
215
|
+
| Hook | Purpose |
|
|
216
|
+
|------|---------|
|
|
217
|
+
| `pre-push` | Ensures upstream sync, blocks direct push to main, enforces single-commit |
|
|
218
|
+
| `pre-commit` | Blocks commits to main, reminds about amend workflow |
|
|
219
|
+
| `post-checkout` | Provides sync reminders when switching branches |
|
|
220
|
+
|
|
221
|
+
**The hooks will automatically:**
|
|
222
|
+
- Block commits directly to main branch
|
|
223
|
+
- Prevent pushing more than 1 commit per branch
|
|
224
|
+
- Warn if your local main is behind upstream
|
|
225
|
+
- Remind you to rebase before pushing
|
|
226
|
+
|
|
227
|
+
### Troubleshooting
|
|
228
|
+
|
|
229
|
+
#### "Too many commits" error
|
|
230
|
+
|
|
231
|
+
If you have multiple commits, squash them:
|
|
232
|
+
|
|
233
|
+
```bash
|
|
234
|
+
# Reset to main (keeps your changes)
|
|
235
|
+
git reset --soft main
|
|
236
|
+
|
|
237
|
+
# Create single commit
|
|
238
|
+
git commit -m "feat: your feature description"
|
|
239
|
+
|
|
240
|
+
# Force push
|
|
241
|
+
git push --force-with-lease
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
#### Local main diverged from upstream
|
|
245
|
+
|
|
246
|
+
```bash
|
|
247
|
+
# Reset your main to match upstream
|
|
248
|
+
git checkout main
|
|
249
|
+
git reset --hard upstream/main
|
|
250
|
+
git push --force-with-lease origin main
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
#### Branch not rebased on main
|
|
254
|
+
|
|
255
|
+
```bash
|
|
256
|
+
# Update main first
|
|
257
|
+
git checkout main
|
|
258
|
+
git pull upstream main
|
|
259
|
+
|
|
260
|
+
# Rebase your branch
|
|
261
|
+
git checkout feat/your-feature
|
|
262
|
+
git rebase main
|
|
263
|
+
|
|
264
|
+
# Force push
|
|
265
|
+
git push --force-with-lease
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
---
|
|
269
|
+
|
|
270
|
+
## What Makes a Good PR?
|
|
271
|
+
|
|
272
|
+
| ✅ Do | ❌ Don't |
|
|
273
|
+
| --------------------------- | ---------------------------- |
|
|
274
|
+
| Change one thing per PR | Mix unrelated changes |
|
|
275
|
+
| Clear title and description | Vague or missing explanation |
|
|
276
|
+
| Reference related issues | Reformat entire files |
|
|
277
|
+
| Small, focused commits | Copy your whole project |
|
|
278
|
+
| Work on a branch | Work directly on `main` |
|
|
279
|
+
|
|
280
|
+
---
|
|
281
|
+
|
|
282
|
+
## Prompt & Agent Guidelines
|
|
283
|
+
|
|
284
|
+
- Keep dev agents lean — focus on coding context, not documentation
|
|
285
|
+
- Web/planning agents can be larger with complex tasks
|
|
286
|
+
- Everything is natural language (markdown) — no code in core framework
|
|
287
|
+
- Use BMad modules for domain-specific features
|
|
288
|
+
- Validate YAML schemas: `npm run validate:schemas`
|
|
289
|
+
|
|
290
|
+
---
|
|
291
|
+
|
|
292
|
+
## Need Help?
|
|
293
|
+
|
|
294
|
+
- 💬 **Discord**: [Join the community](https://discord.gg/gk8jAdXWmj)
|
|
295
|
+
- 🐛 **Bugs**: Use the [bug report template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=bug_report.md)
|
|
296
|
+
- 💡 **Features**: Use the [feature request template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=feature_request.md)
|
|
297
|
+
|
|
298
|
+
---
|
|
299
|
+
|
|
300
|
+
## Code of Conduct
|
|
301
|
+
|
|
302
|
+
By participating, you agree to abide by our [Code of Conduct](.github/CODE_OF_CONDUCT.md).
|
|
303
|
+
|
|
304
|
+
## License
|
|
305
|
+
|
|
306
|
+
By contributing, your contributions are licensed under the same MIT License. See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor attribution.
|
package/CONTRIBUTORS.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Contributors
|
|
2
|
+
|
|
3
|
+
BMad Core, BMad Method and BMad and Community BMad Modules are made possible by contributions from our community. We gratefully acknowledge everyone who has helped improve this project.
|
|
4
|
+
|
|
5
|
+
## How We Credit Contributors
|
|
6
|
+
|
|
7
|
+
- **Git history** — Every contribution is preserved in the project's commit history
|
|
8
|
+
- **Contributors badge** — See the dynamic contributors list on our [README](README.md)
|
|
9
|
+
- **GitHub contributors graph** — Visual representation at <https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors>
|
|
10
|
+
|
|
11
|
+
## Becoming a Contributor
|
|
12
|
+
|
|
13
|
+
Anyone who submits a pull request that is merged becomes a contributor. Contributions include:
|
|
14
|
+
|
|
15
|
+
- Bug fixes
|
|
16
|
+
- New features or workflows
|
|
17
|
+
- Documentation improvements
|
|
18
|
+
- Bug reports and issue triaging
|
|
19
|
+
- Code reviews
|
|
20
|
+
- Helping others in discussions
|
|
21
|
+
|
|
22
|
+
There are no minimum contribution requirements — whether it's a one-character typo fix or a major feature, we value all contributions.
|
|
23
|
+
|
|
24
|
+
## Copyright
|
|
25
|
+
|
|
26
|
+
The BMad Method project is copyrighted by BMad Code, LLC. Individual contributions are licensed under the same MIT License as the project. Contributors retain authorship credit through Git history and the contributors graph.
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
**Thank you to everyone who has helped make BMad Method better!**
|
|
31
|
+
|
|
32
|
+
For contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md).
|
package/LICENSE
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 BMad Code, LLC
|
|
4
|
+
|
|
5
|
+
This project incorporates contributions from the open source community.
|
|
6
|
+
See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor attribution.
|
|
7
|
+
|
|
8
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
9
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
10
|
+
in the Software without restriction, including without limitation the rights
|
|
11
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
12
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
13
|
+
furnished to do so, subject to the following conditions:
|
|
14
|
+
|
|
15
|
+
The above copyright notice and this permission notice shall be included in all
|
|
16
|
+
copies or substantial portions of the Software.
|
|
17
|
+
|
|
18
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
19
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
20
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
21
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
22
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
23
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
24
|
+
SOFTWARE.
|
|
25
|
+
|
|
26
|
+
TRADEMARK NOTICE:
|
|
27
|
+
BMad™, BMad Method™, and BMad Core™ are trademarks of BMad Code, LLC, covering all
|
|
28
|
+
casings and variations (including BMAD, bmad, BMadMethod, BMAD-METHOD, etc.). The use of
|
|
29
|
+
these trademarks in this software does not grant any rights to use the trademarks
|
|
30
|
+
for any other purpose. See [TRADEMARK.md](TRADEMARK.md) for detailed guidelines.
|
package/README.md
ADDED
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+

|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/bmad-method)
|
|
4
|
+
[](LICENSE)
|
|
5
|
+
[](https://nodejs.org)
|
|
6
|
+
[](https://discord.gg/gk8jAdXWmj)
|
|
7
|
+
|
|
8
|
+
**Build More, Architect Dreams** — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
|
|
9
|
+
|
|
10
|
+
**100% free and open source.** No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay.
|
|
11
|
+
|
|
12
|
+
## Why BMad?
|
|
13
|
+
|
|
14
|
+
Traditional AI tools do the thinking for you, producing average results. BMad agents act as expert collaborators who guide you through structured workflows to bring out your best thinking.
|
|
15
|
+
|
|
16
|
+
- **Scale-Adaptive**: Automatically adjusts planning depth based on project complexity (Level 0-4)
|
|
17
|
+
- **Structured Workflows**: Grounded in agile best practices across analysis, planning, architecture, and implementation
|
|
18
|
+
- **Specialized Agents**: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
|
|
19
|
+
- **Complete Lifecycle**: From brainstorming to deployment, with just-in-time documentation
|
|
20
|
+
|
|
21
|
+
## Quick Start
|
|
22
|
+
|
|
23
|
+
**Prerequisites**: [Node.js](https://nodejs.org) v20+
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npx bmad-fh@multi-artifact install
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Follow the installer prompts to configure your project. Then run:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
*workflow-init
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
This analyzes your project and recommends a track:
|
|
36
|
+
|
|
37
|
+
| Track | Best For | Time to First Story |
|
|
38
|
+
| --------------- | ------------------------- | ------------------- |
|
|
39
|
+
| **Quick Flow** | Bug fixes, small features | ~5 minutes |
|
|
40
|
+
| **BMad Method** | Products and platforms | ~15 minutes |
|
|
41
|
+
| **Enterprise** | Compliance-heavy systems | ~30 minutes |
|
|
42
|
+
|
|
43
|
+
## Modules
|
|
44
|
+
|
|
45
|
+
| Module | Purpose |
|
|
46
|
+
| ------------------------------------- | -------------------------------------------------------- |
|
|
47
|
+
| **BMad Method (BMM)** | Core agile development with 34 workflows across 4 phases |
|
|
48
|
+
| **BMad Builder (BMB)** | Create custom agents and domain-specific modules |
|
|
49
|
+
| **Creative Intelligence Suite (CIS)** | Innovation, brainstorming, and problem-solving |
|
|
50
|
+
|
|
51
|
+
## Documentation
|
|
52
|
+
|
|
53
|
+
**[Full Documentation](http://docs.bmad-method.org)** — Tutorials, how-to guides, concepts, and reference
|
|
54
|
+
|
|
55
|
+
- [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/getting-started-bmadv6/)
|
|
56
|
+
- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/)
|
|
57
|
+
|
|
58
|
+
### For v4 Users
|
|
59
|
+
|
|
60
|
+
- **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)**
|
|
61
|
+
|
|
62
|
+
## Multi-Scope Parallel Development
|
|
63
|
+
|
|
64
|
+
BMad supports running multiple workflows in parallel across different terminal sessions with isolated artifacts. Perfect for:
|
|
65
|
+
|
|
66
|
+
- **Multi-team projects** — Each team works in their own scope
|
|
67
|
+
- **Parallel feature development** — Develop auth, payments, and catalog simultaneously
|
|
68
|
+
- **Microservices** — One scope per service with shared contracts
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
# Initialize scope system
|
|
72
|
+
bmad scope init
|
|
73
|
+
|
|
74
|
+
# Create scopes for different services
|
|
75
|
+
bmad scope create auth --name "Authentication"
|
|
76
|
+
bmad scope create payments --name "Payments"
|
|
77
|
+
|
|
78
|
+
# Run workflows in parallel (different terminals)
|
|
79
|
+
bmad workflow create-prd --scope auth # Terminal 1
|
|
80
|
+
bmad workflow create-prd --scope payments # Terminal 2
|
|
81
|
+
|
|
82
|
+
# Share artifacts between scopes
|
|
83
|
+
bmad scope sync-up auth # Promote to shared layer
|
|
84
|
+
bmad scope sync-down payments # Pull shared updates
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
**Key Features:**
|
|
88
|
+
- Read-any, write-own isolation model
|
|
89
|
+
- Shared knowledge layer (`_shared/`) for cross-scope artifacts
|
|
90
|
+
- Event system for dependency notifications
|
|
91
|
+
- Session-sticky scope context
|
|
92
|
+
|
|
93
|
+
See [Multi-Scope Guide](docs/multi-scope-guide.md) for details.
|
|
94
|
+
|
|
95
|
+
## Community
|
|
96
|
+
|
|
97
|
+
- [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate
|
|
98
|
+
- [YouTube](https://www.youtube.com/@BMadCode) — Tutorials, master class, and podcast (launching Feb 2025)
|
|
99
|
+
- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests
|
|
100
|
+
- [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations
|
|
101
|
+
|
|
102
|
+
## Support BMad
|
|
103
|
+
|
|
104
|
+
BMad is free for everyone — and always will be. If you'd like to support development:
|
|
105
|
+
|
|
106
|
+
- ⭐ [Star us on GitHub](https://github.com/bmad-code-org/BMAD-METHOD/) — Helps others discover BMad
|
|
107
|
+
- 📺 [Subscribe on YouTube](https://www.youtube.com/@BMadCode) — Master class launching Feb 2026
|
|
108
|
+
- ☕ [Buy Me a Coffee](https://buymeacoffee.com/bmad) — Fuel the development
|
|
109
|
+
- 🏢 Corporate sponsorship — DM on Discord
|
|
110
|
+
- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (Discord)
|
|
111
|
+
|
|
112
|
+
## Contributing
|
|
113
|
+
|
|
114
|
+
We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
|
115
|
+
|
|
116
|
+
## License
|
|
117
|
+
|
|
118
|
+
MIT License — see [LICENSE](LICENSE) for details.
|
|
119
|
+
|
|
120
|
+
---
|
|
121
|
+
|
|
122
|
+
**BMad** and **BMAD-METHOD** are trademarks of BMad Code, LLC. See [TRADEMARK.md](TRADEMARK.md) for details.
|
|
123
|
+
|
|
124
|
+
[](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors)
|
|
125
|
+
|
|
126
|
+
See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor information.
|
package/SECURITY.md
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported Versions
|
|
4
|
+
|
|
5
|
+
We release security patches for the following versions:
|
|
6
|
+
|
|
7
|
+
| Version | Supported |
|
|
8
|
+
| ------- | ------------------ |
|
|
9
|
+
| Latest | :white_check_mark: |
|
|
10
|
+
| < Latest | :x: |
|
|
11
|
+
|
|
12
|
+
We recommend always using the latest version of BMad Method to ensure you have the most recent security updates.
|
|
13
|
+
|
|
14
|
+
## Reporting a Vulnerability
|
|
15
|
+
|
|
16
|
+
We take security vulnerabilities seriously. If you discover a security issue, please report it responsibly.
|
|
17
|
+
|
|
18
|
+
### How to Report
|
|
19
|
+
|
|
20
|
+
**Do NOT report security vulnerabilities through public GitHub issues.**
|
|
21
|
+
|
|
22
|
+
Instead, please report them via one of these methods:
|
|
23
|
+
|
|
24
|
+
1. **GitHub Security Advisories** (Preferred): Use [GitHub's private vulnerability reporting](https://github.com/bmad-code-org/BMAD-METHOD/security/advisories/new) to submit a confidential report.
|
|
25
|
+
|
|
26
|
+
2. **Discord**: Contact a maintainer directly via DM on our [Discord server](https://discord.gg/gk8jAdXWmj).
|
|
27
|
+
|
|
28
|
+
### What to Include
|
|
29
|
+
|
|
30
|
+
Please include as much of the following information as possible:
|
|
31
|
+
|
|
32
|
+
- Type of vulnerability (e.g., prompt injection, path traversal, etc.)
|
|
33
|
+
- Full paths of source file(s) related to the vulnerability
|
|
34
|
+
- Step-by-step instructions to reproduce the issue
|
|
35
|
+
- Proof-of-concept or exploit code (if available)
|
|
36
|
+
- Impact assessment of the vulnerability
|
|
37
|
+
|
|
38
|
+
### Response Timeline
|
|
39
|
+
|
|
40
|
+
- **Initial Response**: Within 48 hours of receiving your report
|
|
41
|
+
- **Status Update**: Within 7 days with our assessment
|
|
42
|
+
- **Resolution Target**: Critical issues within 30 days; other issues within 90 days
|
|
43
|
+
|
|
44
|
+
### What to Expect
|
|
45
|
+
|
|
46
|
+
1. We will acknowledge receipt of your report
|
|
47
|
+
2. We will investigate and validate the vulnerability
|
|
48
|
+
3. We will work on a fix and coordinate disclosure timing with you
|
|
49
|
+
4. We will credit you in the security advisory (unless you prefer to remain anonymous)
|
|
50
|
+
|
|
51
|
+
## Security Scope
|
|
52
|
+
|
|
53
|
+
### In Scope
|
|
54
|
+
|
|
55
|
+
- Vulnerabilities in BMad Method core framework code
|
|
56
|
+
- Security issues in agent definitions or workflows that could lead to unintended behavior
|
|
57
|
+
- Path traversal or file system access issues
|
|
58
|
+
- Prompt injection vulnerabilities that bypass intended agent behavior
|
|
59
|
+
- Supply chain vulnerabilities in dependencies
|
|
60
|
+
|
|
61
|
+
### Out of Scope
|
|
62
|
+
|
|
63
|
+
- Security issues in user-created custom agents or modules
|
|
64
|
+
- Vulnerabilities in third-party AI providers (Claude, GPT, etc.)
|
|
65
|
+
- Issues that require physical access to a user's machine
|
|
66
|
+
- Social engineering attacks
|
|
67
|
+
- Denial of service attacks that don't exploit a specific vulnerability
|
|
68
|
+
|
|
69
|
+
## Security Best Practices for Users
|
|
70
|
+
|
|
71
|
+
When using BMad Method:
|
|
72
|
+
|
|
73
|
+
1. **Review Agent Outputs**: Always review AI-generated code before executing it
|
|
74
|
+
2. **Limit File Access**: Configure your AI IDE to limit file system access where possible
|
|
75
|
+
3. **Keep Updated**: Regularly update to the latest version
|
|
76
|
+
4. **Validate Dependencies**: Review any dependencies added by generated code
|
|
77
|
+
5. **Environment Isolation**: Consider running AI-assisted development in isolated environments
|
|
78
|
+
|
|
79
|
+
## Acknowledgments
|
|
80
|
+
|
|
81
|
+
We appreciate the security research community's efforts in helping keep BMad Method secure. Contributors who report valid security issues will be acknowledged in our security advisories.
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
Thank you for helping keep BMad Method and our community safe.
|
package/TRADEMARK.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# Trademark Notice & Guidelines
|
|
2
|
+
|
|
3
|
+
## Trademark Ownership
|
|
4
|
+
|
|
5
|
+
The following names and logos are trademarks of BMad Code, LLC:
|
|
6
|
+
|
|
7
|
+
- **BMad** (word mark, all casings: BMad, bmad, BMAD)
|
|
8
|
+
- **BMad Method** (word mark, includes BMadMethod, BMAD-METHOD, and all variations)
|
|
9
|
+
- **BMad Core** (word mark, includes BMadCore, BMAD-CORE, and all variations)
|
|
10
|
+
- **BMad Code** (word mark)
|
|
11
|
+
- BMad Method logo and visual branding
|
|
12
|
+
- The "Build More, Architect Dreams" tagline
|
|
13
|
+
|
|
14
|
+
**All casings, stylings, and variations** of the above names (with or without hyphens, spaces, or specific capitalization) are covered by these trademarks.
|
|
15
|
+
|
|
16
|
+
These trademarks are protected under trademark law and are **not** licensed under the MIT License. The MIT License applies to the software code only, not to the BMad brand identity.
|
|
17
|
+
|
|
18
|
+
## What This Means
|
|
19
|
+
|
|
20
|
+
You may:
|
|
21
|
+
|
|
22
|
+
- Use the BMad software under the terms of the MIT License
|
|
23
|
+
- Refer to BMad to accurately describe compatibility or integration (e.g., "Compatible with BMad Method v6")
|
|
24
|
+
- Link to <https://github.com/bmad-code-org/BMAD-METHOD>
|
|
25
|
+
- Fork the software and distribute your own version under a different name
|
|
26
|
+
|
|
27
|
+
You may **not**:
|
|
28
|
+
|
|
29
|
+
- Use "BMad" or any confusingly similar variation as your product name, service name, company name, or domain name
|
|
30
|
+
- Present your product as officially endorsed, approved, or certified by BMad Code, LLC when it is not, without written consent from an authorized representative of BMad Code, LLC
|
|
31
|
+
- Use BMad logos or branding in a way that suggests your product is an official or endorsed BMad product
|
|
32
|
+
- Register domain names, social media handles, or trademarks that incorporate BMad branding
|
|
33
|
+
|
|
34
|
+
## Examples
|
|
35
|
+
|
|
36
|
+
| Permitted | Not Permitted |
|
|
37
|
+
| ------------------------------------------------------ | -------------------------------------------- |
|
|
38
|
+
| "My workflow tool, compatible with BMad Method" | "BMadFlow" or "BMad Studio" |
|
|
39
|
+
| "An alternative implementation inspired by BMad" | "BMad Pro" or "BMad Enterprise" |
|
|
40
|
+
| "My Awesome Healthcare Module (Bmad Community Module)" | "The Official BMad Core Healthcare Module" |
|
|
41
|
+
| Accurately stating you use BMad as a dependency | Implying official endorsement or partnership |
|
|
42
|
+
|
|
43
|
+
## Commercial Use
|
|
44
|
+
|
|
45
|
+
You may sell products that incorporate or work with BMad software. However:
|
|
46
|
+
|
|
47
|
+
- Your product must have its own distinct name and branding
|
|
48
|
+
- You must not use BMad trademarks in your marketing, domain names, or product identity
|
|
49
|
+
- You may truthfully describe technical compatibility (e.g., "Works with BMad Method")
|
|
50
|
+
|
|
51
|
+
## Questions?
|
|
52
|
+
|
|
53
|
+
If you have questions about trademark usage or would like to discuss official partnership or endorsement opportunities, please reach out:
|
|
54
|
+
|
|
55
|
+
- **Email**: <contact@bmadcode.com>
|
package/Wordmark.png
ADDED
|
Binary file
|
|
Binary file
|
package/docs/404.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Workflow Diagram Maintenance"
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
## Regenerating SVG from Excalidraw
|
|
7
|
+
|
|
8
|
+
When you edit `workflow-method-greenfield.excalidraw`, regenerate the SVG:
|
|
9
|
+
|
|
10
|
+
1. Open <https://excalidraw.com/>
|
|
11
|
+
2. Load the `.excalidraw` file
|
|
12
|
+
3. Click menu (☰) → Export image → SVG
|
|
13
|
+
4. **Set "Scale" to 1x** (default is 2x)
|
|
14
|
+
5. Click "Export"
|
|
15
|
+
6. Save as `workflow-method-greenfield.svg`
|
|
16
|
+
7. **Validate the changes** (see below)
|
|
17
|
+
8. Commit both files together
|
|
18
|
+
|
|
19
|
+
**Important:**
|
|
20
|
+
|
|
21
|
+
- Always use **1x scale** to maintain consistent dimensions
|
|
22
|
+
- Automated export tools (`excalidraw-to-svg`) are broken - use manual export only
|
|
23
|
+
|
|
24
|
+
## Visual Validation
|
|
25
|
+
|
|
26
|
+
After regenerating the SVG, validate that it renders correctly:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
./tools/validate-svg-changes.sh path/to/workflow-method-greenfield.svg
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
This script:
|
|
33
|
+
|
|
34
|
+
- Checks for required dependencies (Playwright, ImageMagick)
|
|
35
|
+
- Installs Playwright locally if needed (no package.json pollution)
|
|
36
|
+
- Renders old vs new SVG using browser-accurate rendering
|
|
37
|
+
- Compares pixel-by-pixel and generates a diff image
|
|
38
|
+
- Outputs a prompt for AI visual analysis (paste into Gemini/Claude)
|
|
39
|
+
|
|
40
|
+
**Threshold**: <0.01% difference is acceptable (anti-aliasing variations)
|