bmad-elsabro 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.auto-claude-security.json +209 -0
- package/.claude_settings.json +34 -0
- package/.coderabbit.yaml +40 -0
- package/.nvmrc +1 -0
- package/.prettierignore +9 -0
- package/AI_TEST_GENERATOR_VERIFICATION.md +260 -0
- package/BUDGET_ALERT_TESTING.md +325 -0
- package/CHANGELOG.md +1488 -0
- package/CNAME +1 -0
- package/CONTRIBUTING.md +167 -0
- package/CONTRIBUTORS.md +32 -0
- package/LEGACY_MIGRATION_TESTING.md +428 -0
- package/LICENSE +30 -0
- package/PARTY_MODE_VERIFICATION.md +274 -0
- package/PROJECT_DETECTOR_TESTING.md +288 -0
- package/README.md +236 -0
- package/SECURITY.md +85 -0
- package/TRADEMARK.md +55 -0
- package/WORKFLOW_ROUTER_IMPLEMENTATION.md +379 -0
- package/Wordmark.png +0 -0
- package/banner-bmad-method.png +0 -0
- package/build/icons/512x512.png +0 -0
- package/build-mac.sh +3 -0
- package/docs/404.md +9 -0
- package/docs/_STYLE_GUIDE.md +367 -0
- package/docs/developer/api-reference.md +945 -0
- package/docs/developer/architecture.md +563 -0
- package/docs/developer/contributing.md +831 -0
- package/docs/downloads.md +74 -0
- package/docs/explanation/advanced-elicitation.md +24 -0
- package/docs/explanation/adversarial-review.md +57 -0
- package/docs/explanation/brainstorming.md +31 -0
- package/docs/explanation/brownfield-faq.md +55 -0
- package/docs/explanation/party-mode.md +57 -0
- package/docs/explanation/preventing-agent-conflicts.md +110 -0
- package/docs/explanation/quick-flow.md +27 -0
- package/docs/explanation/why-solutioning-matters.md +75 -0
- package/docs/how-to/brownfield/index.md +84 -0
- package/docs/how-to/brownfield/quick-fix-in-brownfield.md +76 -0
- package/docs/how-to/customize-bmad.md +158 -0
- package/docs/how-to/get-answers-about-bmad.md +102 -0
- package/docs/how-to/install-bmad.md +82 -0
- package/docs/how-to/shard-large-documents.md +101 -0
- package/docs/how-to/upgrade-to-v6.md +131 -0
- package/docs/index.md +56 -0
- package/docs/reference/workflow-map.md +83 -0
- package/docs/tea/explanation/engagement-models.md +710 -0
- package/docs/tea/explanation/fixture-architecture.md +457 -0
- package/docs/tea/explanation/knowledge-base-system.md +554 -0
- package/docs/tea/explanation/network-first-patterns.md +853 -0
- package/docs/tea/explanation/risk-based-testing.md +586 -0
- package/docs/tea/explanation/tea-overview.md +410 -0
- package/docs/tea/explanation/test-quality-standards.md +907 -0
- package/docs/tea/explanation/testing-as-engineering.md +112 -0
- package/docs/tea/glossary/index.md +159 -0
- package/docs/tea/how-to/brownfield/use-tea-for-enterprise.md +525 -0
- package/docs/tea/how-to/brownfield/use-tea-with-existing-tests.md +577 -0
- package/docs/tea/how-to/customization/enable-tea-mcp-enhancements.md +424 -0
- package/docs/tea/how-to/customization/integrate-playwright-utils.md +813 -0
- package/docs/tea/how-to/workflows/run-atdd.md +436 -0
- package/docs/tea/how-to/workflows/run-automate.md +653 -0
- package/docs/tea/how-to/workflows/run-nfr-assess.md +679 -0
- package/docs/tea/how-to/workflows/run-test-design.md +135 -0
- package/docs/tea/how-to/workflows/run-test-review.md +605 -0
- package/docs/tea/how-to/workflows/run-trace.md +883 -0
- package/docs/tea/how-to/workflows/setup-ci.md +712 -0
- package/docs/tea/how-to/workflows/setup-test-framework.md +98 -0
- package/docs/tea/reference/commands.md +276 -0
- package/docs/tea/reference/configuration.md +678 -0
- package/docs/tea/reference/knowledge-base.md +340 -0
- package/docs/tea/tutorials/tea-lite-quickstart.md +444 -0
- package/docs/tutorials/getting-started.md +205 -0
- package/docs/user-guide/getting-started.md +348 -0
- package/docs/user-guide/token-economy.md +601 -0
- package/docs/user-guide/workflows.md +546 -0
- package/electron-builder.yml +75 -0
- package/eslint.config.mjs +152 -0
- package/package.json +162 -0
- package/prettier.config.mjs +32 -0
- package/public/monaco-workers/index.js +21 -0
- package/renderer/App.tsx +311 -0
- package/renderer/components/ChatPanel.tsx +285 -0
- package/renderer/components/CodeEditor.tsx +327 -0
- package/renderer/components/CodeEditor.types.ts +245 -0
- package/renderer/components/FlowSelector.tsx +534 -0
- package/renderer/components/MessageInput.tsx +252 -0
- package/renderer/components/MessageList.tsx +204 -0
- package/renderer/components/MigrationWizard.tsx +896 -0
- package/renderer/components/NotificationCenter.tsx +291 -0
- package/renderer/components/OnboardingWizard.tsx +112 -0
- package/renderer/components/PartyMode.tsx +555 -0
- package/renderer/components/Sidebar.module.css +258 -0
- package/renderer/components/Sidebar.tsx +157 -0
- package/renderer/components/TemplateSelector.tsx +553 -0
- package/renderer/components/Terminal.tsx +523 -0
- package/renderer/components/TestCenter.tsx +364 -0
- package/renderer/components/TokenAnalytics.tsx +607 -0
- package/renderer/components/TokenMonitor.tsx +331 -0
- package/renderer/components/TutorialOverlay.tsx +483 -0
- package/renderer/components/WorkflowEditor.tsx +470 -0
- package/renderer/components/onboarding/Step1Welcome.tsx +72 -0
- package/renderer/components/onboarding/Step2Setup.tsx +193 -0
- package/renderer/components/onboarding/Step3CreateProject.tsx +209 -0
- package/renderer/components/test-center/CoverageDashboard.tsx +588 -0
- package/renderer/components/test-center/ELI5Guide.tsx +521 -0
- package/renderer/components/test-center/TestList.tsx +381 -0
- package/renderer/components/test-center/TestRunner.tsx +431 -0
- package/renderer/components/test-center/TestStepWizard.tsx +1000 -0
- package/renderer/components/test-center/VisualTestBuilder.tsx +460 -0
- package/renderer/components/workflow/DependencyEdge.tsx +200 -0
- package/renderer/components/workflow/StepNode.tsx +234 -0
- package/renderer/components/workflow/StepPalette.tsx +412 -0
- package/renderer/context/ThemeContext.tsx +97 -0
- package/renderer/data/shortcuts.json +94 -0
- package/renderer/data/testing-guides.json +261 -0
- package/renderer/data/tutorials.json +546 -0
- package/renderer/hooks/useKeyboardShortcuts.ts +249 -0
- package/renderer/hooks/useNotifications.ts +267 -0
- package/renderer/hooks/useTheme.ts +149 -0
- package/renderer/hooks/useTokenTracking.ts +464 -0
- package/renderer/hooks/useWorkflowState.ts +309 -0
- package/renderer/index.html +16 -0
- package/renderer/index.tsx +17 -0
- package/renderer/lib/MONACO_OFFLINE_CONFIG.md +153 -0
- package/renderer/lib/chart-utils.ts +472 -0
- package/renderer/lib/file-system-provider.ts +295 -0
- package/renderer/lib/monaco-loader.ts +247 -0
- package/renderer/renderer/components/NOTIFICATION_SYSTEM.md +192 -0
- package/renderer/styles.css +55 -0
- package/renderer/types/css-modules.d.ts +21 -0
- package/renderer/types/electron.d.ts +316 -0
- package/src/bmm/_module-installer/installer.js +48 -0
- package/src/bmm/agents/analyst.agent.yaml +36 -0
- package/src/bmm/agents/architect.agent.yaml +28 -0
- package/src/bmm/agents/dev.agent.yaml +38 -0
- package/src/bmm/agents/parallel-orchestrator.agent.yaml +50 -0
- package/src/bmm/agents/pm.agent.yaml +46 -0
- package/src/bmm/agents/quick-flow-solo-dev.agent.yaml +32 -0
- package/src/bmm/agents/sm.agent.yaml +36 -0
- package/src/bmm/agents/tea.agent.yaml +63 -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 +45 -0
- package/src/bmm/agents/ux-designer.agent.yaml +26 -0
- package/src/bmm/agents/yolo-dev.agent.yaml +41 -0
- package/src/bmm/data/auto-testing-config.yaml +84 -0
- package/src/bmm/data/guided-mode-instructions.yaml +112 -0
- package/src/bmm/data/parallelization-config.yaml +136 -0
- package/src/bmm/data/project-context-template.md +26 -0
- package/src/bmm/data/speed-profiles.yaml +127 -0
- package/src/bmm/module-help.csv +32 -0
- package/src/bmm/module.yaml +60 -0
- package/src/bmm/teams/default-party.csv +21 -0
- package/src/bmm/teams/team-fullstack.yaml +12 -0
- package/src/bmm/testarch/knowledge/adr-quality-readiness-checklist.md +350 -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 +35 -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 +162 -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-prd/data/domain-complexity.csv +13 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/data/prd-purpose.md +197 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/data/project-types.csv +11 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-01-init.md +191 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-01b-continue.md +153 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02-discovery.md +224 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-03-success.md +226 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-04-journeys.md +213 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-05-domain.md +207 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-06-innovation.md +226 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-07-project-type.md +237 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-08-scoping.md +228 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-09-functional.md +231 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-10-nonfunctional.md +242 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-11-polish.md +217 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md +124 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01-discovery.md +247 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01b-legacy-conversion.md +208 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-02-review.md +249 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-03-edit.md +253 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-04-complete.md +168 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-01-discovery.md +218 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02-format-detection.md +191 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02b-parity-check.md +209 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-03-density-validation.md +174 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-04-brief-coverage-validation.md +214 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-05-measurability-validation.md +228 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-06-traceability-validation.md +217 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-07-implementation-leakage-validation.md +205 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-08-domain-compliance-validation.md +243 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-09-project-type-validation.md +263 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-10-smart-validation.md +209 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-11-holistic-quality-validation.md +264 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-12-completeness-validation.md +242 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md +231 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/templates/prd-template.md +10 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/validation-report-prd-workflow.md +433 -0
- package/src/bmm/workflows/2-plan-workflows/create-prd/workflow.md +150 -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 +171 -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/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 +135 -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 +76 -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 +149 -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 +32 -0
- package/src/bmm/workflows/4-implementation/fix-and-test/workflow.md +197 -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/brownfield-fast-track/steps/step-01-detect.md +55 -0
- package/src/bmm/workflows/bmad-quick-flow/brownfield-fast-track/steps/step-02-confirm.md +48 -0
- package/src/bmm/workflows/bmad-quick-flow/brownfield-fast-track/steps/step-03-implement.md +61 -0
- package/src/bmm/workflows/bmad-quick-flow/brownfield-fast-track/workflow.md +41 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +176 -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 +153 -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 +149 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +73 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +192 -0
- package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +145 -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 +201 -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 +93 -0
- package/src/bmm/workflows/bmad-quick-flow/yolo-mode/steps/step-01-rapid-spec.md +54 -0
- package/src/bmm/workflows/bmad-quick-flow/yolo-mode/steps/step-02-ship-it.md +65 -0
- package/src/bmm/workflows/bmad-quick-flow/yolo-mode/workflow.md +54 -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/parallel-work/parallel-analysis/steps/step-01-parse-target.md +49 -0
- package/src/bmm/workflows/parallel-work/parallel-analysis/steps/step-02-launch-streams.md +135 -0
- package/src/bmm/workflows/parallel-work/parallel-analysis/steps/step-03-sync-point.md +74 -0
- package/src/bmm/workflows/parallel-work/parallel-analysis/steps/step-04-merge-insights.md +179 -0
- package/src/bmm/workflows/parallel-work/parallel-analysis/workflow.md +55 -0
- package/src/bmm/workflows/parallel-work/parallel-generation/workflow.md +109 -0
- package/src/bmm/workflows/parallel-work/parallel-reviews/workflow.md +111 -0
- package/src/bmm/workflows/parallel-work/parallel-stories/workflow.md +112 -0
- package/src/bmm/workflows/parallel-work/sprint-mode/steps/step-01-load-sprint.md +54 -0
- package/src/bmm/workflows/parallel-work/sprint-mode/steps/step-02-plan-execution.md +63 -0
- package/src/bmm/workflows/parallel-work/sprint-mode/steps/step-03-execute-stories.md +112 -0
- package/src/bmm/workflows/parallel-work/sprint-mode/steps/step-04-code-review.md +148 -0
- package/src/bmm/workflows/parallel-work/sprint-mode/steps/step-05-integration-testing.md +200 -0
- package/src/bmm/workflows/parallel-work/sprint-mode/steps/step-06-sprint-report.md +290 -0
- package/src/bmm/workflows/parallel-work/sprint-mode/workflow.md +58 -0
- package/src/bmm/workflows/testarch/atdd/atdd-checklist-template.md +363 -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 +247 -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 +320 -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 +726 -0
- package/src/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +461 -0
- package/src/bmm/workflows/testarch/nfr-assess/workflow.yaml +49 -0
- package/src/bmm/workflows/testarch/test-design/checklist.md +407 -0
- package/src/bmm/workflows/testarch/test-design/instructions.md +1158 -0
- package/src/bmm/workflows/testarch/test-design/test-design-architecture-template.md +213 -0
- package/src/bmm/workflows/testarch/test-design/test-design-qa-template.md +286 -0
- package/src/bmm/workflows/testarch/test-design/test-design-template.md +294 -0
- package/src/bmm/workflows/testarch/test-design/workflow.yaml +71 -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 +642 -0
- package/src/bmm/workflows/testarch/trace/instructions.md +1030 -0
- package/src/bmm/workflows/testarch/trace/trace-template.md +675 -0
- package/src/bmm/workflows/testarch/trace/workflow.yaml +57 -0
- package/src/core/_module-installer/installer.js +60 -0
- package/src/core/agents/bmad-master.agent.yaml +29 -0
- package/src/core/module-help.csv +9 -0
- package/src/core/module.yaml +25 -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 +100 -0
- package/src/core/tasks/editorial-review-structure.xml +209 -0
- package/src/core/tasks/help.md +62 -0
- package/src/core/tasks/index-docs.xml +65 -0
- package/src/core/tasks/review-adversarial-general.xml +48 -0
- package/src/core/tasks/shard-doc.xml +109 -0
- package/src/core/tasks/workflow.xml +235 -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 +14 -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 +6 -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/tools/bmad-npx-wrapper.js +69 -0
- package/tools/build-docs.js +577 -0
- package/tools/cli/README.md +7 -0
- package/tools/cli/bmad-cli.js +65 -0
- package/tools/cli/commands/diagnostics.js +303 -0
- package/tools/cli/commands/install.js +87 -0
- package/tools/cli/commands/module.js +210 -0
- package/tools/cli/commands/status.js +65 -0
- package/tools/cli/commands/uninstall.js +86 -0
- package/tools/cli/external-official-modules.yaml +54 -0
- package/tools/cli/installers/install-messages.yaml +59 -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 +2812 -0
- package/tools/cli/installers/lib/core/manifest-generator.js +1054 -0
- package/tools/cli/installers/lib/core/manifest.js +1036 -0
- package/tools/cli/installers/lib/custom/handler.js +363 -0
- package/tools/cli/installers/lib/ide/_base-ide.js +655 -0
- package/tools/cli/installers/lib/ide/_config-driven.js +450 -0
- package/tools/cli/installers/lib/ide/codex.js +440 -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 +271 -0
- package/tools/cli/installers/lib/ide/platform-codes.js +100 -0
- package/tools/cli/installers/lib/ide/platform-codes.yaml +227 -0
- package/tools/cli/installers/lib/ide/shared/agent-command-generator.js +181 -0
- package/tools/cli/installers/lib/ide/shared/bmad-artifacts.js +163 -0
- package/tools/cli/installers/lib/ide/shared/module-injections.js +136 -0
- package/tools/cli/installers/lib/ide/shared/path-utils.js +292 -0
- package/tools/cli/installers/lib/ide/shared/task-tool-command-generator.js +270 -0
- package/tools/cli/installers/lib/ide/shared/workflow-command-generator.js +319 -0
- package/tools/cli/installers/lib/ide/templates/agent-command-template.md +14 -0
- package/tools/cli/installers/lib/ide/templates/combined/antigravity.md +8 -0
- package/tools/cli/installers/lib/ide/templates/combined/default-agent.md +15 -0
- package/tools/cli/installers/lib/ide/templates/combined/default-workflow-yaml.md +14 -0
- package/tools/cli/installers/lib/ide/templates/combined/default-workflow.md +6 -0
- package/tools/cli/installers/lib/ide/templates/combined/gemini-agent.toml +14 -0
- package/tools/cli/installers/lib/ide/templates/combined/gemini-workflow-yaml.toml +16 -0
- package/tools/cli/installers/lib/ide/templates/combined/gemini-workflow.toml +14 -0
- package/tools/cli/installers/lib/ide/templates/combined/rovodev.md +9 -0
- package/tools/cli/installers/lib/ide/templates/combined/trae.md +9 -0
- package/tools/cli/installers/lib/ide/templates/combined/windsurf-workflow.md +10 -0
- package/tools/cli/installers/lib/ide/templates/split/opencode/body.md +10 -0
- package/tools/cli/installers/lib/ide/templates/split/opencode/header.md +4 -0
- package/tools/cli/installers/lib/ide/templates/workflow-command-template.md +13 -0
- package/tools/cli/installers/lib/ide/templates/workflow-commander.md +5 -0
- package/tools/cli/installers/lib/message-loader.js +85 -0
- package/tools/cli/installers/lib/modules/external-manager.js +135 -0
- package/tools/cli/installers/lib/modules/manager.js +1375 -0
- package/tools/cli/lib/activation-builder.js +163 -0
- package/tools/cli/lib/agent/compiler.js +522 -0
- package/tools/cli/lib/agent/compiler.ts +572 -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/types.ts +155 -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/config.ts +227 -0
- package/tools/cli/lib/file-ops.js +204 -0
- package/tools/cli/lib/file-ops.ts +215 -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/prompts.ts +541 -0
- package/tools/cli/lib/types/config.types.ts +43 -0
- package/tools/cli/lib/types/xml-handler.types.ts +50 -0
- package/tools/cli/lib/ui.js +1660 -0
- package/tools/cli/lib/xml-handler.js +177 -0
- package/tools/cli/lib/xml-handler.ts +188 -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/docs/BUNDLE_DISTRIBUTION_SETUP.md +95 -0
- package/tools/docs/fix-refs.md +91 -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/aggregate.ts +78 -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/files.ts +31 -0
- package/tools/flattener/ignoreRules.js +172 -0
- package/tools/flattener/main.js +483 -0
- package/tools/flattener/main.ts +262 -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/types.ts +53 -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 +491 -0
- package/tools/schema/agent.ts +489 -0
- package/tools/schema/agent.types.ts +31 -0
- package/tools/update-bmad.sh +24 -0
- package/tools/validate-agent-schema.js +110 -0
- package/tools/validate-doc-links.js +371 -0
- package/tools/validate-svg-changes.sh +356 -0
- package/vite-plugin-monaco-editor.ts +108 -0
package/CNAME
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
docs.bmad-method.org
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,167 @@
|
|
|
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
|
+
## What Makes a Good PR?
|
|
132
|
+
|
|
133
|
+
| ✅ Do | ❌ Don't |
|
|
134
|
+
| --------------------------- | ---------------------------- |
|
|
135
|
+
| Change one thing per PR | Mix unrelated changes |
|
|
136
|
+
| Clear title and description | Vague or missing explanation |
|
|
137
|
+
| Reference related issues | Reformat entire files |
|
|
138
|
+
| Small, focused commits | Copy your whole project |
|
|
139
|
+
| Work on a branch | Work directly on `main` |
|
|
140
|
+
|
|
141
|
+
---
|
|
142
|
+
|
|
143
|
+
## Prompt & Agent Guidelines
|
|
144
|
+
|
|
145
|
+
- Keep dev agents lean — focus on coding context, not documentation
|
|
146
|
+
- Web/planning agents can be larger with complex tasks
|
|
147
|
+
- Everything is natural language (markdown) — no code in core framework
|
|
148
|
+
- Use BMad modules for domain-specific features
|
|
149
|
+
- Validate YAML schemas: `npm run validate:schemas`
|
|
150
|
+
|
|
151
|
+
---
|
|
152
|
+
|
|
153
|
+
## Need Help?
|
|
154
|
+
|
|
155
|
+
- 💬 **Discord**: [Join the community](https://discord.gg/gk8jAdXWmj)
|
|
156
|
+
- 🐛 **Bugs**: Use the [bug report template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=bug_report.md)
|
|
157
|
+
- 💡 **Features**: Use the [feature request template](https://github.com/bmad-code-org/BMAD-METHOD/issues/new?template=feature_request.md)
|
|
158
|
+
|
|
159
|
+
---
|
|
160
|
+
|
|
161
|
+
## Code of Conduct
|
|
162
|
+
|
|
163
|
+
By participating, you agree to abide by our [Code of Conduct](.github/CODE_OF_CONDUCT.md).
|
|
164
|
+
|
|
165
|
+
## License
|
|
166
|
+
|
|
167
|
+
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).
|
|
@@ -0,0 +1,428 @@
|
|
|
1
|
+
# Legacy Migration Wizard - Testing Guide
|
|
2
|
+
|
|
3
|
+
This guide provides comprehensive instructions for manually verifying the legacy migration wizard functionality.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
The legacy migration wizard helps users migrate their existing BMAD projects to the new BMAD Studio Electron app format. It detects legacy project structures, backs up original data, and converts agents, workflows, and configuration files to the new format.
|
|
8
|
+
|
|
9
|
+
## Prerequisites
|
|
10
|
+
|
|
11
|
+
Before testing, ensure:
|
|
12
|
+
- Electron app is running (`npm run electron:dev`)
|
|
13
|
+
- You have a legacy BMAD project to test with (or use test fixtures)
|
|
14
|
+
- The app has write permissions to create backups
|
|
15
|
+
|
|
16
|
+
## Test Scenarios
|
|
17
|
+
|
|
18
|
+
### Scenario 1: Detect Legacy Project
|
|
19
|
+
|
|
20
|
+
**Purpose**: Verify that the wizard can correctly identify legacy BMAD projects.
|
|
21
|
+
|
|
22
|
+
**Steps**:
|
|
23
|
+
1. Open BMAD Studio
|
|
24
|
+
2. Navigate to "Import Legacy Project" or trigger the Migration Wizard
|
|
25
|
+
3. Click "Browse..." or enter a path manually
|
|
26
|
+
4. Select a directory containing a legacy BMAD project
|
|
27
|
+
|
|
28
|
+
**Expected Results**:
|
|
29
|
+
- Wizard detects legacy structure (`.bmad/`, `_bmad/`, or `src/bmm/`)
|
|
30
|
+
- Displays count of agents, workflows, steps, and config
|
|
31
|
+
- Shows detected version (e.g., "1.x")
|
|
32
|
+
- Lists any issues found (e.g., "No agent files found")
|
|
33
|
+
- Success message: "✅ Legacy BMAD project detected! Click 'Next' to review."
|
|
34
|
+
|
|
35
|
+
**Test Data**:
|
|
36
|
+
```
|
|
37
|
+
Legacy project structure example:
|
|
38
|
+
/path/to/legacy/project/
|
|
39
|
+
.bmad/
|
|
40
|
+
agents/
|
|
41
|
+
dev.agent.yaml
|
|
42
|
+
qa.agent.yaml
|
|
43
|
+
analyst.agent.yaml
|
|
44
|
+
workflows/
|
|
45
|
+
dev-story.workflow.yaml
|
|
46
|
+
code-review.workflow.yaml
|
|
47
|
+
config.json
|
|
48
|
+
steps/
|
|
49
|
+
step1.md
|
|
50
|
+
step2.md
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Scenario 2: Review Detection Results
|
|
54
|
+
|
|
55
|
+
**Purpose**: Verify that detection results are accurately displayed.
|
|
56
|
+
|
|
57
|
+
**Steps**:
|
|
58
|
+
1. Complete Scenario 1
|
|
59
|
+
2. Click "Next" to proceed to Review step
|
|
60
|
+
|
|
61
|
+
**Expected Results**:
|
|
62
|
+
- Displays 4 summary cards with counts:
|
|
63
|
+
- **Agents**: Shows number of `.agent.yaml` files (e.g., "8")
|
|
64
|
+
- **Workflows**: Shows number of `.workflow.yaml` files (e.g., "12")
|
|
65
|
+
- **Steps**: Shows number of `.md` step files (e.g., "45")
|
|
66
|
+
- **Configuration**: Shows ✅ if config.json exists, ❌ otherwise
|
|
67
|
+
- Shows detected version in blue info box
|
|
68
|
+
- Lists any issues in yellow warning box
|
|
69
|
+
- All counts match actual files in legacy project
|
|
70
|
+
|
|
71
|
+
### Scenario 3: Configure Migration Options
|
|
72
|
+
|
|
73
|
+
**Purpose**: Verify that users can configure migration behavior.
|
|
74
|
+
|
|
75
|
+
**Steps**:
|
|
76
|
+
1. Complete Scenario 2
|
|
77
|
+
2. Click "Next" to proceed to Configure step
|
|
78
|
+
3. Test the following options:
|
|
79
|
+
- Toggle "Create backup before migration" (should be checked by default)
|
|
80
|
+
- Toggle "Preserve original files" (should be checked by default)
|
|
81
|
+
- Check/uncheck individual skip options:
|
|
82
|
+
- "Skip agents"
|
|
83
|
+
- "Skip workflows"
|
|
84
|
+
- "Skip config"
|
|
85
|
+
|
|
86
|
+
**Expected Results**:
|
|
87
|
+
- All checkboxes are functional
|
|
88
|
+
- Default state: backup and preserve are enabled
|
|
89
|
+
- Tip message displays recommendation
|
|
90
|
+
- Visual feedback on hover (background changes)
|
|
91
|
+
- State is preserved if you go back and return to this step
|
|
92
|
+
|
|
93
|
+
### Scenario 4: Execute Migration
|
|
94
|
+
|
|
95
|
+
**Purpose**: Verify that migration executes correctly with progress tracking.
|
|
96
|
+
|
|
97
|
+
**Steps**:
|
|
98
|
+
1. Complete Scenario 3
|
|
99
|
+
2. Click "Start Migration" button
|
|
100
|
+
3. Observe the migration progress
|
|
101
|
+
|
|
102
|
+
**Expected Results**:
|
|
103
|
+
- Migration steps appear sequentially:
|
|
104
|
+
1. ⏳ → ⚡ → ✅ **Detect Legacy Project**: "Scanning project for legacy structure"
|
|
105
|
+
2. ⏳ → ⚡ → ✅ **Create Backup**: "Backing up original project" (if enabled)
|
|
106
|
+
3. ⏳ → ⚡ → ✅ **Migrate Agents**: "Migrating X agent files"
|
|
107
|
+
4. ⏳ → ⚡ → ✅ **Migrate Workflows**: "Migrating X workflow files"
|
|
108
|
+
5. ⏳ → ⚡ → ✅ **Migrate Configuration**: "Migrating project configuration"
|
|
109
|
+
6. ⏳ → ⚡ → ✅ **Finalize Migration**: "Completing migration and cleanup"
|
|
110
|
+
- Each step shows:
|
|
111
|
+
- Status emoji (⏳ pending, ⚡ running, ✅ completed, ❌ failed, ⏭️ skipped)
|
|
112
|
+
- Step name and description
|
|
113
|
+
- Progress percentage (0-100%)
|
|
114
|
+
- Progress bar animation when running
|
|
115
|
+
- UI is blocked during migration (buttons disabled)
|
|
116
|
+
- Migration completes within reasonable time (< 30 seconds for small projects)
|
|
117
|
+
|
|
118
|
+
### Scenario 5: Review Migration Results (Success)
|
|
119
|
+
|
|
120
|
+
**Purpose**: Verify that successful migration results are displayed correctly.
|
|
121
|
+
|
|
122
|
+
**Steps**:
|
|
123
|
+
1. Complete Scenario 4 (successful migration)
|
|
124
|
+
2. Observe the results screen
|
|
125
|
+
|
|
126
|
+
**Expected Results**:
|
|
127
|
+
- Success celebration: 🎉
|
|
128
|
+
- Success message: "Migration Completed Successfully!"
|
|
129
|
+
- Summary metrics displayed:
|
|
130
|
+
- **Agents Migrated**: Shows count (e.g., "8")
|
|
131
|
+
- **Workflows Migrated**: Shows count (e.g., "12")
|
|
132
|
+
- **Config Migrated**: Shows ✅ or ❌
|
|
133
|
+
- Backup location displayed with full path
|
|
134
|
+
- "Next Steps" checklist shows 5 items:
|
|
135
|
+
1. Review migrated agents in Agents section
|
|
136
|
+
2. Check workflows in Workflow Editor
|
|
137
|
+
3. Verify configuration in Settings
|
|
138
|
+
4. Run test workflow
|
|
139
|
+
5. Remove backup if satisfied
|
|
140
|
+
- "Done" button closes wizard
|
|
141
|
+
|
|
142
|
+
### Scenario 6: Review Migration Results (Failure)
|
|
143
|
+
|
|
144
|
+
**Purpose**: Verify that failed migration is handled gracefully.
|
|
145
|
+
|
|
146
|
+
**Steps**:
|
|
147
|
+
1. Attempt migration with invalid/inaccessible path
|
|
148
|
+
2. Or simulate failure by canceling migration (if implemented)
|
|
149
|
+
|
|
150
|
+
**Expected Results**:
|
|
151
|
+
- Failure indicator: 😞
|
|
152
|
+
- Error message: "Migration Failed"
|
|
153
|
+
- Specific error description displayed
|
|
154
|
+
- Failed step shows ❌ status with error message
|
|
155
|
+
- Summary metrics show actual counts migrated before failure
|
|
156
|
+
- User can go back or close wizard
|
|
157
|
+
|
|
158
|
+
### Scenario 7: Keyboard Navigation
|
|
159
|
+
|
|
160
|
+
**Purpose**: Verify that keyboard shortcuts work correctly.
|
|
161
|
+
|
|
162
|
+
**Steps**:
|
|
163
|
+
1. Open Migration Wizard
|
|
164
|
+
2. Test the following keyboard actions:
|
|
165
|
+
- Press **Enter** to advance to next step
|
|
166
|
+
- Press **Escape** to go back to previous step
|
|
167
|
+
- Press **Escape** on first step to close wizard
|
|
168
|
+
|
|
169
|
+
**Expected Results**:
|
|
170
|
+
- Enter advances wizard (when not blocked)
|
|
171
|
+
- Escape goes back or closes wizard
|
|
172
|
+
- Keyboard shortcuts disabled during migration
|
|
173
|
+
- Visual feedback shows which button would be triggered
|
|
174
|
+
|
|
175
|
+
### Scenario 8: Theme Support
|
|
176
|
+
|
|
177
|
+
**Purpose**: Verify that wizard supports dark/light themes.
|
|
178
|
+
|
|
179
|
+
**Steps**:
|
|
180
|
+
1. Open wizard in light theme
|
|
181
|
+
2. Verify all elements are visible and readable
|
|
182
|
+
3. Switch to dark theme (toggle in app header)
|
|
183
|
+
4. Verify all elements adapt correctly
|
|
184
|
+
|
|
185
|
+
**Expected Results**:
|
|
186
|
+
- **Light Theme**:
|
|
187
|
+
- White background
|
|
188
|
+
- Dark text
|
|
189
|
+
- Light borders
|
|
190
|
+
- Blue accent colors
|
|
191
|
+
- **Dark Theme**:
|
|
192
|
+
- Dark gray background
|
|
193
|
+
- Light text
|
|
194
|
+
- Dark borders
|
|
195
|
+
- Blue accent colors (slightly adjusted)
|
|
196
|
+
- All text is readable in both themes
|
|
197
|
+
- No color contrast issues
|
|
198
|
+
- Smooth theme transitions
|
|
199
|
+
|
|
200
|
+
### Scenario 9: Multiple Legacy Structures
|
|
201
|
+
|
|
202
|
+
**Purpose**: Verify detection of different legacy directory patterns.
|
|
203
|
+
|
|
204
|
+
**Steps**:
|
|
205
|
+
Test detection with different legacy project structures:
|
|
206
|
+
1. `.bmad/` directory structure
|
|
207
|
+
2. `_bmad/` directory structure
|
|
208
|
+
3. `src/bmm/agents/` structure (like current project)
|
|
209
|
+
4. `src/bmad/` structure
|
|
210
|
+
5. No legacy structure (should fail detection)
|
|
211
|
+
|
|
212
|
+
**Expected Results**:
|
|
213
|
+
- All valid structures are detected
|
|
214
|
+
- Appropriate counts for each structure
|
|
215
|
+
- Non-legacy projects show error: "No legacy BMAD project detected"
|
|
216
|
+
- Version detection works for each structure
|
|
217
|
+
|
|
218
|
+
### Scenario 10: Backup Creation
|
|
219
|
+
|
|
220
|
+
**Purpose**: Verify that backups are created correctly.
|
|
221
|
+
|
|
222
|
+
**Steps**:
|
|
223
|
+
1. Enable "Create backup before migration"
|
|
224
|
+
2. Complete migration
|
|
225
|
+
3. Navigate to backup location (shown in results)
|
|
226
|
+
4. Verify backup contents
|
|
227
|
+
|
|
228
|
+
**Expected Results**:
|
|
229
|
+
- Backup directory exists at displayed path
|
|
230
|
+
- Backup path format: `{app-userData}/migrations/{project-name}-{timestamp}`
|
|
231
|
+
- Backup contains all original files:
|
|
232
|
+
- All agent files preserved
|
|
233
|
+
- All workflow files preserved
|
|
234
|
+
- Config file preserved (if exists)
|
|
235
|
+
- Step files preserved
|
|
236
|
+
- Original files unchanged if "Preserve original" enabled
|
|
237
|
+
- Backup can be used for rollback
|
|
238
|
+
|
|
239
|
+
## File Verification
|
|
240
|
+
|
|
241
|
+
After migration, verify that files were created in the correct locations:
|
|
242
|
+
|
|
243
|
+
### Agents Location
|
|
244
|
+
```
|
|
245
|
+
{app-userData}/agents/
|
|
246
|
+
dev.agent.yaml (with migration metadata)
|
|
247
|
+
qa.agent.yaml
|
|
248
|
+
analyst.agent.yaml
|
|
249
|
+
...
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
### Workflows Location
|
|
253
|
+
```
|
|
254
|
+
{app-userData}/workflows/
|
|
255
|
+
dev-story.json (converted from YAML to JSON)
|
|
256
|
+
code-review.json
|
|
257
|
+
...
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
### Configuration Location
|
|
261
|
+
```
|
|
262
|
+
{app-userData}/config-migrated.json
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
### Backup Location
|
|
266
|
+
```
|
|
267
|
+
{app-userData}/migrations/
|
|
268
|
+
{project-name}-{timestamp}/
|
|
269
|
+
.bmad/
|
|
270
|
+
agents/
|
|
271
|
+
workflows/
|
|
272
|
+
config.json
|
|
273
|
+
steps/
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
## Expected File Contents
|
|
277
|
+
|
|
278
|
+
### Migrated Agent File
|
|
279
|
+
```yaml
|
|
280
|
+
agent:
|
|
281
|
+
metadata:
|
|
282
|
+
id: "_bmad/bmm/agents/dev.md"
|
|
283
|
+
name: "Developer Agent"
|
|
284
|
+
migratedAt: "2026-01-29T00:00:00.000Z"
|
|
285
|
+
migratedFrom: "/path/to/original/dev.agent.yaml"
|
|
286
|
+
persona:
|
|
287
|
+
role: "Senior Software Engineer"
|
|
288
|
+
# ... rest of agent definition preserved
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
### Migrated Workflow File
|
|
292
|
+
```json
|
|
293
|
+
{
|
|
294
|
+
"id": "dev-story",
|
|
295
|
+
"name": "Dev Story Workflow",
|
|
296
|
+
"nodes": [],
|
|
297
|
+
"edges": [],
|
|
298
|
+
"metadata": {
|
|
299
|
+
"migratedAt": "2026-01-29T00:00:00.000Z",
|
|
300
|
+
"migratedFrom": "/path/to/original/dev-story.workflow.yaml",
|
|
301
|
+
"legacyData": {
|
|
302
|
+
// Original YAML data preserved here
|
|
303
|
+
}
|
|
304
|
+
},
|
|
305
|
+
"createdAt": "2026-01-29T00:00:00.000Z",
|
|
306
|
+
"updatedAt": "2026-01-29T00:00:00.000Z"
|
|
307
|
+
}
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
## Common Issues and Troubleshooting
|
|
311
|
+
|
|
312
|
+
### Issue: "No legacy BMAD project detected"
|
|
313
|
+
**Solution**: Verify directory structure matches expected patterns (`.bmad/`, `_bmad/`, `src/bmm/`)
|
|
314
|
+
|
|
315
|
+
### Issue: Migration fails with permission error
|
|
316
|
+
**Solution**: Ensure app has write permissions to user data directory
|
|
317
|
+
|
|
318
|
+
### Issue: Migration hangs or takes too long
|
|
319
|
+
**Solution**: Check console for errors, verify file system access, restart app
|
|
320
|
+
|
|
321
|
+
### Issue: Backup not created
|
|
322
|
+
**Solution**: Verify "Create backup" option is checked, check disk space
|
|
323
|
+
|
|
324
|
+
### Issue: Files not found in new location
|
|
325
|
+
**Solution**: Check app's userData directory path (varies by OS):
|
|
326
|
+
- **macOS**: `~/Library/Application Support/BMAD-Studio/`
|
|
327
|
+
- **Windows**: `%APPDATA%/BMAD-Studio/`
|
|
328
|
+
- **Linux**: `~/.config/BMAD-Studio/`
|
|
329
|
+
|
|
330
|
+
## Integration Testing
|
|
331
|
+
|
|
332
|
+
After verifying the wizard works, test integration with other app features:
|
|
333
|
+
|
|
334
|
+
1. **Agent Editor**: Open migrated agent files and verify they load correctly
|
|
335
|
+
2. **Workflow Editor**: Open migrated workflows and verify they display (even if nodes/edges are empty)
|
|
336
|
+
3. **Settings**: Verify migrated config is accessible
|
|
337
|
+
4. **Test Center**: Run tests on migrated project
|
|
338
|
+
|
|
339
|
+
## Performance Benchmarks
|
|
340
|
+
|
|
341
|
+
Expected performance for different project sizes:
|
|
342
|
+
|
|
343
|
+
- **Small** (< 10 agents, < 10 workflows): < 5 seconds
|
|
344
|
+
- **Medium** (10-50 agents, 10-50 workflows): < 15 seconds
|
|
345
|
+
- **Large** (50-100 agents, 50-100 workflows): < 30 seconds
|
|
346
|
+
- **Huge** (> 100 agents, > 100 workflows): < 60 seconds
|
|
347
|
+
|
|
348
|
+
## Reporting Issues
|
|
349
|
+
|
|
350
|
+
When reporting issues, include:
|
|
351
|
+
- Project structure (number of agents, workflows, steps)
|
|
352
|
+
- Migration options selected
|
|
353
|
+
- Error messages displayed
|
|
354
|
+
- Console logs (DevTools → Console)
|
|
355
|
+
- Migration report JSON (if available)
|
|
356
|
+
- Backup location and contents
|
|
357
|
+
|
|
358
|
+
## Notes for Developers
|
|
359
|
+
|
|
360
|
+
### Mock Data
|
|
361
|
+
The wizard currently uses mock data for demonstration. To test with real data:
|
|
362
|
+
1. Comment out mock responses in `MigrationWizard.tsx`
|
|
363
|
+
2. Uncomment IPC calls to `window.electron.legacyMigrator.*`
|
|
364
|
+
3. Ensure Electron app is running
|
|
365
|
+
|
|
366
|
+
### Event Listeners
|
|
367
|
+
Monitor IPC events in console:
|
|
368
|
+
```javascript
|
|
369
|
+
// In DevTools Console
|
|
370
|
+
window.electron.legacyMigrator.on('step-start', console.log);
|
|
371
|
+
window.electron.legacyMigrator.on('step-progress', console.log);
|
|
372
|
+
window.electron.legacyMigrator.on('step-complete', console.log);
|
|
373
|
+
window.electron.legacyMigrator.on('migration-complete', console.log);
|
|
374
|
+
window.electron.legacyMigrator.on('error', console.log);
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
### Testing Backend Independently
|
|
378
|
+
Test the backend service directly:
|
|
379
|
+
```typescript
|
|
380
|
+
import { getLegacyMigrator } from './electron/services/legacy-migrator';
|
|
381
|
+
|
|
382
|
+
const migrator = getLegacyMigrator();
|
|
383
|
+
|
|
384
|
+
// Test detection
|
|
385
|
+
const info = await migrator.detectLegacyProject('/path/to/project');
|
|
386
|
+
console.log(info);
|
|
387
|
+
|
|
388
|
+
// Test migration
|
|
389
|
+
const result = await migrator.migrateProject({
|
|
390
|
+
sourcePath: '/path/to/project',
|
|
391
|
+
createBackup: true,
|
|
392
|
+
preserveOriginal: true,
|
|
393
|
+
});
|
|
394
|
+
console.log(result);
|
|
395
|
+
```
|
|
396
|
+
|
|
397
|
+
## Success Criteria
|
|
398
|
+
|
|
399
|
+
The migration wizard is considered successful when:
|
|
400
|
+
- [x] Detects all legacy project structures
|
|
401
|
+
- [x] Displays accurate counts and information
|
|
402
|
+
- [x] Creates backups before migration
|
|
403
|
+
- [x] Migrates agents with metadata preserved
|
|
404
|
+
- [x] Converts workflows to new JSON format
|
|
405
|
+
- [x] Migrates configuration files
|
|
406
|
+
- [x] Shows real-time progress during migration
|
|
407
|
+
- [x] Handles errors gracefully with clear messages
|
|
408
|
+
- [x] Supports dark/light themes
|
|
409
|
+
- [x] Works with keyboard navigation
|
|
410
|
+
- [x] Provides detailed migration reports
|
|
411
|
+
- [x] Allows rollback using backups
|
|
412
|
+
|
|
413
|
+
## Manual Verification Checklist
|
|
414
|
+
|
|
415
|
+
- [ ] Legacy project detected correctly
|
|
416
|
+
- [ ] Detection results accurate (counts match actual files)
|
|
417
|
+
- [ ] Configuration options functional
|
|
418
|
+
- [ ] Migration executes with progress tracking
|
|
419
|
+
- [ ] Success results display correctly
|
|
420
|
+
- [ ] Failure handling works gracefully
|
|
421
|
+
- [ ] Keyboard navigation functional (Enter/Escape)
|
|
422
|
+
- [ ] Dark/light theme support verified
|
|
423
|
+
- [ ] Multiple legacy structures detected
|
|
424
|
+
- [ ] Backups created correctly
|
|
425
|
+
- [ ] Migrated files in correct locations
|
|
426
|
+
- [ ] Migrated content preserves original data
|
|
427
|
+
- [ ] Integration with other features works
|
|
428
|
+
- [ ] Performance meets benchmarks
|
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.
|