bmad-method 6.0.2 → 6.0.3

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [6.0.3]
+
+### 🐛 Bug Fixes
+
+* Fix workflow descriptions to use proper quotes so they format better in skill conversion and don't break yaml front matter
+
+---
+
 ## [6.0.2]
 
 ### 🎁 Features

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "bmad-method",
-  "version": "6.0.2",
+  "version": "6.0.3",
   "description": "Breakthrough Method of Agile AI-driven Development",
   "keywords": [
     "agile",

package/src/bmm/agents/qa.agent.yaml

@@ -29,7 +29,7 @@ agent:
 
   menu:
     - trigger: QA or fuzzy match on qa-automate
-      workflow: "{project-root}/_bmad/bmm/workflows/qa/automate/workflow.yaml"
+      workflow: "{project-root}/_bmad/bmm/workflows/qa-generate-e2e-tests/workflow.yaml"
       description: "[QA] Automate - Generate tests for existing features (simplified)"
 
   prompts:

package/src/bmm/module-help.csv

@@ -27,5 +27,5 @@ bmm,4-implementation,Validate Story,VS,35,_bmad/bmm/workflows/4-implementation/c
 bmm,4-implementation,Create Story,CS,30,_bmad/bmm/workflows/4-implementation/create-story/workflow.yaml,bmad-bmm-create-story,true,sm,Create Mode,"Story cycle start: Prepare first found story in the sprint plan that is next, or if the command is run with a specific epic and story designation with context. Once complete, then VS then DS then CR then back to DS if needed or next CS or ER",implementation_artifacts,story,
 bmm,4-implementation,Dev Story,DS,40,_bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml,bmad-bmm-dev-story,true,dev,Create Mode,"Story cycle: Execute story implementation tasks and tests then CR then back to DS if fixes needed",,,
 bmm,4-implementation,Code Review,CR,50,_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml,bmad-bmm-code-review,false,dev,Create Mode,"Story cycle: If issues back to DS if approved then next CS or ER if epic complete",,,
-bmm,4-implementation,QA Automation Test,QA,45,_bmad/bmm/workflows/qa/automate/workflow.yaml,bmad-bmm-qa-automate,false,qa,Create Mode,"Generate automated API and E2E tests for implemented code using the project's existing test framework (detects existing well known in use test frameworks). Use after implementation to add test coverage. NOT for code review or story validation - use CR for that.",implementation_artifacts,"test suite",
+bmm,4-implementation,QA Automation Test,QA,45,_bmad/bmm/workflows/qa-generate-e2e-tests/workflow.yaml,bmad-bmm-qa-automate,false,qa,Create Mode,"Generate automated API and E2E tests for implemented code using the project's existing test framework (detects existing well known in use test frameworks). Use after implementation to add test coverage. NOT for code review or story validation - use CR for that.",implementation_artifacts,"test suite",
 bmm,4-implementation,Retrospective,ER,60,_bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml,bmad-bmm-retrospective,false,sm,Create Mode,"Optional at epic end: Review completed work lessons learned and next epic or if major issues consider CC",implementation_artifacts,retrospective,

package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md

@@ -128,7 +128,7 @@ Recap that the brief captures everything needed to guide subsequent product deve
 
 ### 5. Suggest next steps
 
-Product Brief complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md` with argument `Validate PRD`.
+Product Brief complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md`
 
 ---
 

package/src/bmm/workflows/1-analysis/create-product-brief/workflow.md

@@ -1,6 +1,6 @@
 ---
 name: create-product-brief
-description: Create product brief through collaborative discovery. Use when the user says 'lets create a product brief' or 'help me create a project brief'
+description: 'Create product brief through collaborative discovery. Use when the user says "lets create a product brief" or "help me create a project brief"'
 ---
 
 # Product Brief Workflow

package/src/bmm/workflows/1-analysis/research/workflow-domain-research.md

@@ -1,6 +1,6 @@
 ---
 name: domain-research
-description: Conduct domain and industry research. Use when the user says 'lets create a research report on [domain or industry]
+description: 'Conduct domain and industry research. Use when the user says "lets create a research report on [domain or industry]"'
 ---
 
 # Domain Research Workflow

package/src/bmm/workflows/1-analysis/research/workflow-market-research.md

@@ -1,6 +1,6 @@
 ---
 name: market-research
-description: Conduct market research on competition and customers. Use when the user says 'create a market research report about [business idea]'.
+description: 'Conduct market research on competition and customers. Use when the user says "create a market research report about [business idea]".'
 ---
 
 # Market Research Workflow

package/src/bmm/workflows/1-analysis/research/workflow-technical-research.md

@@ -1,6 +1,6 @@
 ---
 name: technical-research
-description: Conduct technical research on technologies and architecture. Use when the user says 'create a technical research report on [topic]'.
+description: 'Conduct technical research on technologies and architecture. Use when the user says "create a technical research report on [topic]".'
 ---
 
 # Technical Research Workflow

package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md

@@ -87,7 +87,7 @@ Offer validation workflows to ensure PRD is ready for implementation:
 
 ### 4. Suggest Next Workflows
 
-PRD complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md` with argument `Create PRD`.
+PRD complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md`
 
 ### 5. Final Completion Confirmation
 

package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md

@@ -197,7 +197,7 @@ Display:
 - **IF X (Exit):**
   - Display: "**Validation Report Saved:** {validationReportPath}"
   - Display: "**Summary:** {overall status} - {recommendation}"
-  - PRD Validation complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md` with argument `Validate PRD`.
+  - PRD Validation complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md`
 
 - **IF Any other:** Help user, then redisplay menu
 

package/src/bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md

@@ -1,6 +1,6 @@
 ---
 name: create-prd
-description: Create a PRD from scratch. Use when the user says 'lets create a product requirements document' or 'I want to create a new PRD'
+description: 'Create a PRD from scratch. Use when the user says "lets create a product requirements document" or "I want to create a new PRD"'
 main_config: '{project-root}/_bmad/bmm/config.yaml'
 nextStep: './steps-c/step-01-init.md'
 ---

package/src/bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md

@@ -1,6 +1,6 @@
 ---
 name: edit-prd
-description: Edit an existing PRD. Use when the user says 'edit this PRD'.
+description: 'Edit an existing PRD. Use when the user says "edit this PRD".'
 main_config: '{project-root}/_bmad/bmm/config.yaml'
 editWorkflow: './steps-e/step-e-01-discovery.md'
 ---

package/src/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md

@@ -1,6 +1,6 @@
 ---
 name: validate-prd
-description: Validate a PRD against standards. Use when the user says 'validate this PRD' or 'run PRD validation'
+description: 'Validate a PRD against standards. Use when the user says "validate this PRD" or "run PRD validation"'
 main_config: '{project-root}/_bmad/bmm/config.yaml'
 validateWorkflow: './steps-v/step-v-01-discovery.md'
 ---

package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md

@@ -82,7 +82,7 @@ Update the main workflow status file:
 
 ### 3. Suggest Next Steps
 
-UX Design complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md` with argument `Create UX`.
+UX Design complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md`
 
 ### 5. Final Completion Confirmation
 

package/src/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md

@@ -1,6 +1,6 @@
 ---
 name: create-ux-design
-description: Plan UX patterns and design specifications. Use when the user says 'lets create UX design' or 'create UX specifications' or 'help me plan the UX'
+description: 'Plan UX patterns and design specifications. Use when the user says "lets create UX design" or "create UX specifications" or "help me plan the UX"'
 ---
 
 # Create UX Design Workflow

package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md

@@ -109,7 +109,7 @@ The assessment found [number] issues requiring attention. Review the detailed re
 
 The implementation readiness workflow is now complete. The report contains all findings and recommendations for the user to consider.
 
-Implementation Readiness complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md` with argument `implementation readiness`.
+Implementation Readiness complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md`
 
 ---
 

package/src/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md

@@ -1,6 +1,6 @@
 ---
 name: check-implementation-readiness
-description: Validate PRD, UX, Architecture and Epics specs are complete. Use when the user says 'check implementation readiness'.
+description: 'Validate PRD, UX, Architecture and Epics specs are complete. Use when the user says "check implementation readiness".'
 ---
 
 # Implementation Readiness

package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md

@@ -41,7 +41,7 @@ completedAt: '{{current_date}}'
 
 ### 3. Next Steps Guidance
 
-Architecture complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md` with argument `Create Architecture`.
+Architecture complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md`
 
 Upon Completion of task output: offer to answer any questions about the Architecture Document.
 

package/src/bmm/workflows/3-solutioning/create-architecture/workflow.md

@@ -1,6 +1,6 @@
 ---
 name: create-architecture
-description: Create architecture solution design decisions for AI agent consistency. Use when the user says 'lets create architecture' or 'create technical architecture' or 'create a solution design'
+description: 'Create architecture solution design decisions for AI agent consistency. Use when the user says "lets create architecture" or "create technical architecture" or "create a solution design"'
 ---
 
 # Architecture Workflow

package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md

@@ -144,6 +144,6 @@ If all validations pass:
 
 When C is selected, the workflow is complete and the epics.md is ready for development.
 
-Epics and Stories complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md` with argument `Create Epics and Stories`.
+Epics and Stories complete. Read fully and follow: `{project-root}/_bmad/core/tasks/help.md`
 
 Upon Completion of task output: offer to answer any questions about the Epics and Stories.

package/src/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md

@@ -1,6 +1,6 @@
 ---
 name: create-epics-and-stories
-description: Break requirements into epics and user stories. Use when the user says 'create the epics and stories list'
+description: 'Break requirements into epics and user stories. Use when the user says "create the epics and stories list"'
 ---
 
 # Create Epics and Stories

package/src/bmm/workflows/4-implementation/code-review/workflow.yaml

@@ -1,6 +1,6 @@
 # Review Story Workflow
 name: code-review
-description: "Perform adversarial code review finding specific issues. Use when the user says 'run code review' or 'review this code'"
+description: 'Perform adversarial code review finding specific issues. Use when the user says "run code review" or "review this code"'
 
 # Critical variables from config
 config_source: "{project-root}/_bmad/bmm/config.yaml"

package/src/bmm/workflows/4-implementation/correct-course/workflow.yaml

@@ -1,6 +1,6 @@
 # Correct Course - Sprint Change Management Workflow
 name: "correct-course"
-description: "Manage significant changes during sprint execution. Use when the user says 'correct course' or 'propose sprint change'"
+description: 'Manage significant changes during sprint execution. Use when the user says "correct course" or "propose sprint change"'
 
 config_source: "{project-root}/_bmad/bmm/config.yaml"
 user_name: "{config_source}:user_name"

package/src/bmm/workflows/4-implementation/create-story/workflow.yaml

@@ -1,5 +1,5 @@
 name: create-story
-description: "Creates a dedicated story file with all the context the agent will need to implement it later. Use when the user says 'create the next story' or 'create story [story identifier]'"
+description: 'Creates a dedicated story file with all the context the agent will need to implement it later. Use when the user says "create the next story" or "create story [story identifier]"'
 
 # Critical variables from config
 config_source: "{project-root}/_bmad/bmm/config.yaml"

package/src/bmm/workflows/4-implementation/dev-story/workflow.yaml

@@ -1,5 +1,5 @@
 name: dev-story
-description: "Execute story implementation following a context filled story spec file. Use when the user says 'dev this story [story file]' or 'implement the next story in the sprint plan'"
+description: 'Execute story implementation following a context filled story spec file. Use when the user says "dev this story [story file]" or "implement the next story in the sprint plan"'
 
 # Critical variables from config
 config_source: "{project-root}/_bmad/bmm/config.yaml"

package/src/bmm/workflows/4-implementation/retrospective/workflow.yaml

@@ -1,6 +1,6 @@
 # Retrospective - Epic Completion Review Workflow
 name: "retrospective"
-description: "Post-epic review to extract lessons and assess success. Use when the user says 'run a retrospective' or 'lets retro the epic [epic]'"
+description: 'Post-epic review to extract lessons and assess success. Use when the user says "run a retrospective" or "lets retro the epic [epic]"'
 
 config_source: "{project-root}/_bmad/bmm/config.yaml"
 user_name: "{config_source}:user_name"

package/src/bmm/workflows/4-implementation/sprint-planning/workflow.yaml

@@ -1,5 +1,5 @@
 name: sprint-planning
-description: "Generate sprint status tracking from epics. Use when the user says 'run sprint planning' or 'generate sprint plan'"
+description: 'Generate sprint status tracking from epics. Use when the user says "run sprint planning" or "generate sprint plan"'
 author: "BMad"
 
 # Critical variables from config

package/src/bmm/workflows/4-implementation/sprint-status/workflow.yaml

@@ -1,6 +1,6 @@
 # Sprint Status - Implementation Tracker
 name: sprint-status
-description: "Summarize sprint status and surface risks. Use when the user says 'check sprint status' or 'show sprint status'"
+description: 'Summarize sprint status and surface risks. Use when the user says "check sprint status" or "show sprint status"'
 author: "BMad"
 
 # Critical variables from config

package/src/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md

@@ -1,6 +1,6 @@
 ---
 name: quick-dev
-description: "Implement a Quick Tech Spec for small changes or features. Use when the user provides a quick tech spec and says 'implement this quick spec' or 'proceed with implementation of [quick tech spec]'"
+description: 'Implement a Quick Tech Spec for small changes or features. Use when the user provides a quick tech spec and says "implement this quick spec" or "proceed with implementation of [quick tech spec]"'
 ---
 
 # Quick Dev Workflow

package/src/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md

@@ -1,6 +1,6 @@
 ---
 name: quick-spec
-description: Very quick process to create implementation-ready quick specs for small changes or features. Use when the user says 'create a quick spec' or 'generate a quick tech spec'
+description: 'Very quick process to create implementation-ready quick specs for small changes or features. Use when the user says "create a quick spec" or "generate a quick tech spec"'
 main_config: '{project-root}/_bmad/bmm/config.yaml'
 
 # Checkpoint handler paths

package/src/bmm/workflows/document-project/workflow.yaml

@@ -1,7 +1,7 @@
 # Document Project Workflow Configuration
 name: "document-project"
 version: "1.2.0"
-description: "Document brownfield projects for AI context. Use when the user says 'document this project' or 'generate project docs'"
+description: 'Document brownfield projects for AI context. Use when the user says "document this project" or "generate project docs"'
 author: "BMad"
 
 # Critical variables

package/src/bmm/workflows/generate-project-context/workflow.md

@@ -1,6 +1,6 @@
 ---
 name: generate-project-context
-description: Create project-context.md with AI rules. Use when the user says 'generate project context' or 'create project context'
+description: 'Create project-context.md with AI rules. Use when the user says "generate project context" or "create project context"'
 ---
 
 # Generate Project Context Workflow

package/src/bmm/workflows/qa-generate-e2e-tests/workflow.yaml

@@ -1,5 +1,5 @@
 name: qa-generate-e2e-tests
-description: "Generate end to end automated tests for existing features. Use when the user says 'create qa automated tests for [feature]'"
+description: 'Generate end to end automated tests for existing features. Use when the user says "create qa automated tests for [feature]"'
 
 # Critical variables from config
 config_source: "{project-root}/_bmad/bmm/config.yaml"
@@ -10,7 +10,7 @@ document_output_language: "{config_source}:document_output_language"
 date: system-generated
 
 # Workflow components
-installed_path: "{project-root}/_bmad/bmm/workflows/qa/automate"
+installed_path: "{project-root}/_bmad/bmm/workflows/qa-generate-e2e-tests"
 instructions: "{installed_path}/instructions.md"
 validation: "{installed_path}/checklist.md"
 template: false

package/src/core/tasks/editorial-review-prose.xml

@@ -1,6 +1,6 @@
 <task id="_bmad/core/tasks/editorial-review-prose.xml"
   name="Editorial Review - Prose"
-  description="Clinical copy-editor that reviews text for communication issues. Use when user says 'review for prose' or 'improve the prose'">
+  description="Clinical copy-editor that reviews text for communication issues. Use when user says review for prose or improve the prose">
 
   <objective>Review text for communication issues that impede comprehension and output suggested fixes in a three-column table</objective>
 

package/src/core/tasks/editorial-review-structure.xml

@@ -3,7 +3,7 @@
   but no context except the content to review -->
 <task id="_bmad/core/tasks/editorial-review-structure.xml"
   name="Editorial Review - Structure"
-  description="Structural editor that proposes cuts, reorganization, and simplification while preserving comprehension. Use when user requests 'structural review' or 'cohesive reivew' or 'editorial review of structure'.">
+  description="Structural editor that proposes cuts, reorganization, and simplification while preserving comprehension. Use when user requests structural review or editorial review of structure">
   <objective>Review document structure and propose substantive changes
     to improve clarity and flow-run this BEFORE copy editing</objective>
   <inputs>

package/src/core/tasks/help.md

@@ -1,6 +1,6 @@
 ---
 name: help
-description: "Analyzes what is done and the users query and offers advice on what to do next. Use if user says 'bmad-help what should I do next' or 'bmad-help what do I do now'"
+description: "Analyzes what is done and the users query and offers advice on what to do next. Use if user says what should I do next or what do I do now"
 ---
 
 # Task: BMAD Help

package/src/core/tasks/index-docs.xml

@@ -1,5 +1,5 @@
 <task id="_bmad/core/tasks/index-docs" name="Index Docs"
-  description="Generates or updates an index.md to reference all docs in the folder. Use if user requests to 'create an index of all files [here]' or 'reindex the folder [here].">
+  description="Generates or updates an index.md to reference all docs in the folder. Use if user requests to create or update an index of all files in a specific folder">
   <llm critical="true">
     <i>MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER</i>
     <i>DO NOT skip steps or change the sequence</i>

package/src/core/tasks/review-adversarial-general.xml

@@ -2,7 +2,7 @@
   but no context except the content to review -->
 
 <task id="_bmad/core/tasks/review-adversarial-general.xml" name="Adversarial Review (General)"
-  description="Perform a Cynical Review and produce a findings report. Use when the user requests a 'critical review of' or 'cynical review of' something.">
+  description="Perform a Cynical Review and produce a findings report. Use when the user requests a critical review of something">
   <objective>Cynically review content and produce findings</objective>
 
   <inputs>

package/src/core/tasks/shard-doc.xml

@@ -1,5 +1,5 @@
 <task id="_bmad/core/tasks/shard-doc" name="Shard Document"
-  description="Splits large markdown documents into smaller, organized files based on level 2 (default) sections. Use if the user says 'Shard Document [document]'">
+  description="Splits large markdown documents into smaller, organized files based on level 2 (default) sections. Use if the user says perform shard document">
   <objective>Split large markdown documents into smaller, organized files based on level 2 sections using @kayvan/markdown-tree-parser tool</objective>
 
   <llm critical="true">

package/src/core/workflows/advanced-elicitation/workflow.xml

@@ -1,5 +1,5 @@
 <task id="_bmad/core/workflows/advanced-elicitation/workflow.xml" name="Advanced Elicitation"
-  description="Push the LLM to reconsider refine and improve its recent output. Use when the user asks for 'advanced elicitation'"
+  description="Push the LLM to reconsider refine and improve its recent output. Use when the user asks for advanced elicitation"
   methods="{project-root}/_bmad/core/workflows/advanced-elicitation/methods.csv"
   agent-party="{project-root}/_bmad/_config/agent-manifest.csv">
   <llm critical="true">

package/src/core/workflows/brainstorming/workflow.md

@@ -1,6 +1,6 @@
 ---
 name: brainstorming
-description: "Facilitate interactive brainstorming sessions using diverse creative techniques and ideation methods. Use when the user says 'help me brainstorm' or 'help me ideate'."
+description: 'Facilitate interactive brainstorming sessions using diverse creative techniques and ideation methods. Use when the user says "help me brainstorm" or "help me ideate".'
 context_file: '' # Optional context file path for project-specific guidance
 ---
 

package/src/core/workflows/party-mode/workflow.md

@@ -1,6 +1,6 @@
 ---
 name: party-mode
-description: "Orchestrates group discussions between all installed BMAD agents, enabling natural multi-agent conversations. Use when user requests 'party mode' only."
+description: 'Orchestrates group discussions between all installed BMAD agents, enabling natural multi-agent conversations. Use when user requests "party mode" only.'
 ---
 
 # Party Mode Workflow

package/test/test-installation-components.js

@@ -173,7 +173,7 @@ async function runTests() {
 
       assert(compiled.includes('QA Engineer'), 'QA agent compilation includes agent title');
 
-      assert(compiled.includes('qa/automate'), 'QA agent menu includes automate workflow');
+      assert(compiled.includes('qa-generate-e2e-tests'), 'QA agent menu includes automate workflow');
 
       // Cleanup
       await fs.remove(tempOutput);