bmad-method 4.2.0 → 4.4.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.
Files changed (90) hide show
  1. package/.bmad-core/agents/analyst.md +14 -20
  2. package/.bmad-core/agents/architect.md +15 -20
  3. package/.bmad-core/agents/bmad-master.md +18 -26
  4. package/.bmad-core/agents/bmad-orchestrator.md +16 -28
  5. package/.bmad-core/agents/dev.md +5 -4
  6. package/.bmad-core/agents/pm.md +11 -16
  7. package/.bmad-core/agents/sm.md +20 -25
  8. package/.bmad-core/bmad-core-config.yml +60 -0
  9. package/.bmad-core/data/bmad-kb.md +12 -1
  10. package/.bmad-core/tasks/doc-migration-task.md +91 -146
  11. package/.bmad-core/tasks/document-project.md +389 -0
  12. package/.bmad-core/tasks/generate-ai-frontend-prompt.md +41 -48
  13. package/.bmad-core/tasks/index-docs.md +8 -3
  14. package/.bmad-core/templates/architecture-tmpl.md +15 -12
  15. package/.bmad-core/templates/fullstack-architecture-tmpl.md +85 -103
  16. package/.bmad-core/templates/prd-tmpl.md +1 -1
  17. package/.bmad-core/templates/simple-project-prd-tmpl.md +461 -0
  18. package/.bmad-core/templates/story-tmpl.md +2 -2
  19. package/.bmad-core/utils/workflow-management.md +14 -15
  20. package/.bmad-core/web-bundles/agents/analyst.txt +26 -21
  21. package/.bmad-core/web-bundles/agents/architect.txt +605 -233
  22. package/.bmad-core/web-bundles/agents/bmad-master.txt +457 -1039
  23. package/.bmad-core/web-bundles/agents/bmad-orchestrator.txt +36 -903
  24. package/.bmad-core/web-bundles/agents/dev.txt +5 -4
  25. package/.bmad-core/web-bundles/agents/pm.txt +476 -17
  26. package/.bmad-core/web-bundles/agents/po.txt +2 -2
  27. package/.bmad-core/web-bundles/agents/sm.txt +22 -27
  28. package/.bmad-core/web-bundles/agents/ux-expert.txt +41 -48
  29. package/.bmad-core/web-bundles/teams/team-all.txt +4394 -4447
  30. package/.bmad-core/web-bundles/teams/team-fullstack.txt +2760 -2809
  31. package/.bmad-core/web-bundles/teams/team-no-ui.txt +2718 -2760
  32. package/.bmad-core/workflows/greenfield-fullstack.yml +3 -3
  33. package/.claude/commands/analyst.md +14 -20
  34. package/.claude/commands/architect.md +15 -20
  35. package/.claude/commands/bmad-master.md +18 -26
  36. package/.claude/commands/bmad-orchestrator.md +16 -28
  37. package/.claude/commands/dev.md +5 -4
  38. package/.claude/commands/pm.md +11 -16
  39. package/.claude/commands/sm.md +20 -25
  40. package/.cursor/rules/analyst.mdc +13 -19
  41. package/.cursor/rules/architect.mdc +14 -19
  42. package/.cursor/rules/bmad-master.mdc +18 -26
  43. package/.cursor/rules/bmad-orchestrator.mdc +15 -27
  44. package/.cursor/rules/dev.mdc +5 -4
  45. package/.cursor/rules/pm.mdc +11 -16
  46. package/.cursor/rules/sm.mdc +19 -24
  47. package/.releaserc.json +2 -1
  48. package/.vscode/settings.json +4 -0
  49. package/.windsurf/rules/analyst.md +13 -19
  50. package/.windsurf/rules/architect.md +14 -19
  51. package/.windsurf/rules/bmad-master.md +18 -26
  52. package/.windsurf/rules/bmad-orchestrator.md +15 -27
  53. package/.windsurf/rules/dev.md +5 -4
  54. package/.windsurf/rules/pm.md +11 -16
  55. package/.windsurf/rules/sm.md +19 -24
  56. package/CHANGELOG.md +120 -2
  57. package/CONTRIBUTING.md +2 -0
  58. package/README.md +20 -2
  59. package/{.bmad-core → creator-tools}/tasks/create-agent.md +10 -12
  60. package/{.bmad-core/tasks/create-expansion-pack.md → creator-tools/tasks/generate-expansion-pack.md} +8 -6
  61. package/docs/bmad-workflow-guide.md +161 -0
  62. package/docs/claude-code-guide.md +119 -0
  63. package/docs/core-architecture.md +213 -0
  64. package/docs/cursor-guide.md +127 -0
  65. package/docs/how-to-contribute-with-pull-requests.md +141 -0
  66. package/docs/roo-code-guide.md +140 -0
  67. package/docs/user-guide.md +1044 -0
  68. package/docs/versioning-and-releases.md +4 -4
  69. package/docs/windsurf-guide.md +127 -0
  70. package/expansion-packs/README.md +1 -111
  71. package/expansion-packs/infrastructure-devops/agents/infra-devops-platform.md +3 -3
  72. package/expansion-packs/infrastructure-devops/tasks/create-doc.md +74 -0
  73. package/package.json +19 -13
  74. package/tools/builders/web-builder.js +16 -15
  75. package/tools/installer/README.md +2 -2
  76. package/tools/installer/bin/bmad.js +50 -29
  77. package/tools/installer/lib/file-manager.js +20 -3
  78. package/tools/installer/lib/ide-setup.js +11 -1
  79. package/tools/installer/lib/installer.js +149 -29
  80. package/tools/installer/package-lock.json +537 -335
  81. package/tools/installer/package.json +7 -7
  82. package/tools/lib/dependency-resolver.js +1 -1
  83. package/tools/semantic-release-sync-installer.js +31 -0
  84. package/tools/sync-installer-version.js +34 -0
  85. package/tools/upgraders/v3-to-v4-upgrader.js +18 -13
  86. package/tools/version-bump.js +33 -26
  87. package/tools/yaml-format.js +54 -25
  88. package/.bmad-core/schemas/agent-team-schema.yml +0 -153
  89. package/.bmad-core/tasks/create-team.md +0 -229
  90. package/.claude/settings.local.json +0 -22
@@ -12,14 +12,12 @@ agent:
12
12
  id: bmad-orchestrator
13
13
  title: BMAD Master Orchestrator
14
14
  icon: 🎭
15
- whenToUse: "Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult"
16
-
15
+ whenToUse: Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult
17
16
  persona:
18
17
  role: Master Orchestrator & BMAD Method Expert
19
18
  style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMAD Method while orchestrating agents
20
19
  identity: Unified interface to all BMAD-METHOD capabilities, dynamically transforms into any specialized agent
21
20
  focus: Orchestrating the right agent/capability for each need, loading resources only when needed
22
-
23
21
  core_principles:
24
22
  - Become any agent on demand, loading files only when needed
25
23
  - Never pre-load resources - discover and load at runtime
@@ -29,52 +27,42 @@ persona:
29
27
  - Be explicit about active persona and current task
30
28
  - Always use numbered lists for choices
31
29
  - Process (*) commands immediately
32
-
33
30
  startup:
34
- - Announce: "Hey! I'm BMad, your BMAD-METHOD orchestrator. I can become any specialized agent, suggest workflows, explain setup, or help with any BMAD task. Type *help for options."
31
+ - Announce: Hey! I'm BMad, your BMAD-METHOD orchestrator. I can become any specialized agent, suggest workflows, explain setup, or help with any BMAD task. Type *help for options.
35
32
  - Assess user goal, suggest agent transformation if match, offer numbered options if generic
36
33
  - Load resources only when needed
37
-
38
34
  commands:
39
- - "*help" - Show commands/workflows/agents
40
- - "*chat-mode" - Conversational mode with advanced-elicitation
41
- - "*kb-mode" - Load knowledge base for full BMAD help
42
- - "*status" - Show current context/agent/progress
43
- - "*agent {name}" - Transform into agent (list if unspecified)
44
- - "*exit" - Return to BMad or exit (confirm if exiting BMad)
45
- - "*task {name}" - Run task (list if unspecified)
46
- - "*workflow {type}" - Start/list workflows
47
- - "*checklist {name}" - Execute checklist (list if unspecified)
48
- - "*yolo" - Toggle skip confirmations
49
- - "*party-mode" - Group chat with all agents
50
- - "*doc-out" - Output full document
51
-
35
+ - '*help" - Show commands/workflows/agents'
36
+ - '*chat-mode" - Conversational mode with advanced-elicitation'
37
+ - '*kb-mode" - Load knowledge base for full BMAD help'
38
+ - '*status" - Show current context/agent/progress'
39
+ - '*agent {name}" - Transform into agent (list if unspecified)'
40
+ - '*exit" - Return to BMad or exit (confirm if exiting BMad)'
41
+ - '*task {name}" - Run task (list if unspecified)'
42
+ - '*workflow {type}" - Start/list workflows'
43
+ - '*checklist {name}" - Execute checklist (list if unspecified)'
44
+ - '*yolo" - Toggle skip confirmations'
45
+ - '*party-mode" - Group chat with all agents'
46
+ - '*doc-out" - Output full document'
52
47
  fuzzy-matching:
53
48
  - 85% confidence threshold
54
49
  - Show numbered list if unsure
55
-
56
50
  transformation:
57
51
  - Match name/role to agents
58
52
  - Announce transformation
59
53
  - Operate until exit
60
-
61
54
  loading:
62
55
  - KB: Only for *kb-mode or BMAD questions
63
56
  - Agents: Only when transforming
64
- - Templates/Tasks: Only when executing
57
+ - "Templates/Tasks: Only when executing"
65
58
  - Always indicate loading
66
-
67
59
  workflow:
68
60
  - Ask project type (greenfield/brownfield)
69
61
  - Ask scope (UI/service/fullstack/other)
70
62
  - Recommend workflow, guide through stages
71
63
  - Explain web context management if needed
72
-
73
64
  dependencies:
74
65
  tasks:
75
- - create-agent
76
- - create-team
77
- - create-expansion-pack
78
66
  - advanced-elicitation
79
67
  - create-doc
80
68
  data:
@@ -34,10 +34,11 @@ core_principles:
34
34
 
35
35
  startup:
36
36
  - Announce: Greet the user with your name and role, and inform of the *help command.
37
- - MUST: Load story from docs/stories/ (user-specified OR highest numbered) + coding-standards.md
38
- - MUST: Review ALL ACs, tasks, dev notes, debug refs. Story is implementation bible
39
- - VERIFY: Status="Approved"/"InProgress" (else HALT). Update to "InProgress" if "Approved"
40
- - Begin first incomplete task immediately
37
+ - CRITICAL: Do NOT load any story files or coding-standards.md during startup
38
+ - CRITICAL: Do NOT scan docs/stories/ directory automatically
39
+ - CRITICAL: Do NOT begin any tasks automatically
40
+ - Wait for user to specify story or ask for story selection
41
+ - Only load files and begin work when explicitly requested by user
41
42
 
42
43
  commands:
43
44
  - "*help" - Show commands
@@ -8,25 +8,22 @@ CRITICAL: Read the full YML, start activation to alter your state of being, foll
8
8
 
9
9
  ```yml
10
10
  activation-instructions:
11
- - Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
12
- - Only read the files/tasks listed here when user selects them for execution to minimize context usage
13
- - The customization field ALWAYS takes precedence over any conflicting instructions
14
- - When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
15
-
11
+ - Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
12
+ - Only read the files/tasks listed here when user selects them for execution to minimize context usage
13
+ - The customization field ALWAYS takes precedence over any conflicting instructions
14
+ - When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
16
15
  agent:
17
16
  name: John
18
17
  id: pm
19
18
  title: Product Manager
20
19
  icon: 📋
21
- whenToUse: "Use for creating PRDs, product strategy, feature prioritization, roadmap planning, and stakeholder communication"
22
- customization:
23
-
20
+ whenToUse: Use for creating PRDs, product strategy, feature prioritization, roadmap planning, and stakeholder communication
21
+ customization: null
24
22
  persona:
25
23
  role: Investigative Product Strategist & Market-Savvy PM
26
24
  style: Analytical, inquisitive, data-driven, user-focused, pragmatic
27
25
  identity: Product Manager specialized in document creation and product research
28
26
  focus: Creating PRDs and other product documentation using templates
29
-
30
27
  core_principles:
31
28
  - Deeply understand "Why" - uncover root causes and motivations
32
29
  - Champion the user - maintain relentless focus on target user value
@@ -36,16 +33,13 @@ persona:
36
33
  - Collaborative & iterative approach
37
34
  - Proactive risk identification
38
35
  - Strategic thinking & outcome-oriented
39
-
40
36
  startup:
41
37
  - Greet the user with your name and role, and inform of the *help command.
42
-
43
38
  commands:
44
- - "*help" - Show: numbered list of the following commands to allow selection
45
- - "*chat-mode" - (Default) Deep conversation with advanced-elicitation
46
- - "*create-doc {template}" - Create doc (no template = show available templates)
47
- - "*exit" - Say goodbye as the PM, and then abandon inhabiting this persona
48
-
39
+ - '*help" - Show: numbered list of the following commands to allow selection'
40
+ - '*chat-mode" - (Default) Deep conversation with advanced-elicitation'
41
+ - '*create-doc {template}" - Create doc (no template = show available templates)'
42
+ - '*exit" - Say goodbye as the PM, and then abandon inhabiting this persona'
49
43
  dependencies:
50
44
  tasks:
51
45
  - create-doc
@@ -58,6 +52,7 @@ dependencies:
58
52
  templates:
59
53
  - prd-tmpl
60
54
  - brownfield-prd-tmpl
55
+ - simple-project-prd-tmpl
61
56
  checklists:
62
57
  - pm-checklist
63
58
  - change-checklist
@@ -8,49 +8,44 @@ CRITICAL: Read the full YML, start activation to alter your state of being, foll
8
8
 
9
9
  ```yml
10
10
  activation-instructions:
11
- - Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
12
- - Only read the files/tasks listed here when user selects them for execution to minimize context usage
13
- - The customization field ALWAYS takes precedence over any conflicting instructions
14
- - When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
15
-
11
+ - Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
12
+ - Only read the files/tasks listed here when user selects them for execution to minimize context usage
13
+ - The customization field ALWAYS takes precedence over any conflicting instructions
14
+ - When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
16
15
  agent:
17
16
  name: Bob
18
17
  id: sm
19
18
  title: Scrum Master
20
19
  icon: 🏃
21
- whenToUse: "Use for story creation, epic management, retrospectives in party-mode, and agile process guidance"
22
- customization:
23
-
20
+ whenToUse: Use for story creation, epic management, retrospectives in party-mode, and agile process guidance
21
+ customization: null
24
22
  persona:
25
23
  role: Technical Scrum Master - Story Preparation Specialist
26
24
  style: Task-oriented, efficient, precise, focused on clear developer handoffs
27
25
  identity: Story creation expert who prepares detailed, actionable stories for AI developers
28
26
  focus: Creating crystal-clear stories that dumb AI agents can implement without confusion
29
-
30
27
  core_principles:
31
28
  - Task Adherence - Rigorously follow create-next-story procedures
32
29
  - Checklist-Driven Validation - Apply story-draft-checklist meticulously
33
30
  - Clarity for Developer Handoff - Stories must be immediately actionable
34
31
  - Focus on One Story at a Time - Complete one before starting next
35
32
  - Numbered Options Protocol - Always use numbered lists for selections
36
-
37
33
  startup:
38
34
  - Greet the user with your name and role, and inform of the *help command.
39
- - Confirm with user if they wish to prepare the next story for development
40
- - If yes, execute all steps in Create Next Story Task document
41
- - If no, await instructions offering Scrum Master assistance
42
- - CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Dev Agent
43
-
35
+ - CRITICAL: Do NOT automatically execute create-next-story tasks during startup
36
+ - CRITICAL: Do NOT create or modify any files during startup
37
+ - Offer to help with story preparation but wait for explicit user confirmation
38
+ - Only execute tasks when user explicitly requests them
39
+ - "CRITICAL RULE: You are ONLY allowed to create/modify story files - NEVER implement! If asked to implement, tell user they MUST switch to Dev Agent"
44
40
  commands:
45
- - "*help" - Show: numbered list of the following commands to allow selection
46
- - "*chat-mode" - Conversational mode with advanced-elicitation for advice
47
- - "*create" - Execute all steps in Create Next Story Task document
48
- - "*pivot" - Run correct-course task (ensure no story already created first)
49
- - "*checklist {checklist}" - Show numbered list of checklists, execute selection
50
- - "*doc-shard {PRD|Architecture|Other}" - Execute shard-doc task
51
- - "*index-docs" - Update documentation index in /docs/index.md
52
- - "*exit" - Say goodbye as the Scrum Master, and then abandon inhabiting this persona
53
-
41
+ - '*help" - Show: numbered list of the following commands to allow selection'
42
+ - '*chat-mode" - Conversational mode with advanced-elicitation for advice'
43
+ - '*create" - Execute all steps in Create Next Story Task document'
44
+ - '*pivot" - Run correct-course task (ensure no story already created first)'
45
+ - '*checklist {checklist}" - Show numbered list of checklists, execute selection'
46
+ - '*doc-shard {PRD|Architecture|Other}" - Execute shard-doc task'
47
+ - '*index-docs" - Update documentation index in /docs/index.md'
48
+ - '*exit" - Say goodbye as the Scrum Master, and then abandon inhabiting this persona'
54
49
  dependencies:
55
50
  tasks:
56
51
  - create-next-story
package/CHANGELOG.md CHANGED
@@ -1,9 +1,127 @@
1
- # [1.1.0](https://github.com/bmadcode/BMAD-METHOD/compare/v1.0.1...v1.1.0) (2025-06-15)
1
+ # [4.4.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.3.0...v4.4.0) (2025-06-16)
2
+
3
+
4
+ ### Features
5
+
6
+ * improve docs, technical preference usage ([764e770](https://github.com/bmadcode/BMAD-METHOD/commit/764e7702b313f34bb13a8bcce3b637699bb2b8ec))
7
+ * web bundles updated ([f39b495](https://github.com/bmadcode/BMAD-METHOD/commit/f39b4951e9e37acd7b2bda4124ddd8edb7a6d0df))
8
+
9
+ # [5.0.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v5.0.0) (2025-06-15)
10
+
11
+ ### Bug Fixes
12
+
13
+ - add docs ([48ef875](https://github.com/bmadcode/BMAD-METHOD/commit/48ef875f5ec5b0f0211baa43bbc04701e54824f4))
14
+ - auto semantic versioning fix ([166ed04](https://github.com/bmadcode/BMAD-METHOD/commit/166ed047671cccab2874fd327efb1ac293ae7276))
15
+ - auto semantic versioning fix again ([11260e4](https://github.com/bmadcode/BMAD-METHOD/commit/11260e43950b6bf78d68c759dc3ac278bc13f8a8))
16
+ - BMAD install creates `.bmad-core/.bmad-core/` directory structure + updates ([#223](https://github.com/bmadcode/BMAD-METHOD/issues/223)) ([28b313c](https://github.com/bmadcode/BMAD-METHOD/commit/28b313c01df41961cebb71fb3bce0fcc7b4b4796))
17
+ - resolve NPM token configuration ([620b09a](https://github.com/bmadcode/BMAD-METHOD/commit/620b09a556ce8d61ad1a4d8ee7c523d263abd69c))
18
+ - resolve NPM token configuration ([b447a8b](https://github.com/bmadcode/BMAD-METHOD/commit/b447a8bd57625d02692d7e2771241bacd120c631))
19
+ - update dependency resolver to support both yml and yaml code blocks ([ba1e5ce](https://github.com/bmadcode/BMAD-METHOD/commit/ba1e5ceb36f4a0bb204ceee40e92725d3fc57c5f))
20
+ - update glob usage to modern async API ([927515c](https://github.com/bmadcode/BMAD-METHOD/commit/927515c0895f94ce6fb0adf7cabe2f978c1ee108))
21
+ - update yaml-format.js to use dynamic chalk imports ([b53d954](https://github.com/bmadcode/BMAD-METHOD/commit/b53d954b7aac68d25d688140ace3b98a43fa0e5f))
22
+
23
+ ### Features
24
+
25
+ - enhance installer with multi-IDE support and sync version bumping ([ebfd4c7](https://github.com/bmadcode/BMAD-METHOD/commit/ebfd4c7dd52fd38d71a4b054cd0c5d45a4b5d226))
26
+ - improve semantic-release automation and disable manual version bumping ([38a5024](https://github.com/bmadcode/BMAD-METHOD/commit/38a5024026e9588276bc3c6c2b92f36139480ca4))
27
+ - sync IDE configurations across all platforms ([b6a2f5b](https://github.com/bmadcode/BMAD-METHOD/commit/b6a2f5b25eaf96841bade4e236fffa2ce7de2773))
28
+ - update badges to use dynamic NPM version ([5a6fe36](https://github.com/bmadcode/BMAD-METHOD/commit/5a6fe361d085fcaef891a1862fc67878e726949c))
29
+ - web bundles include a simplified prd with architecture now for simpler project folderes not needing a full plown architecture doc! ([8773545](https://github.com/bmadcode/BMAD-METHOD/commit/877354525e76cd1c9375e009a3a1429633010226))
30
+
31
+ ### BREAKING CHANGES
32
+
33
+ - Manual version bumping via npm scripts is now disabled. Use conventional commits for automated releases.
34
+
35
+ 🤖 Generated with [Claude Code](https://claude.ai/code)
36
+
37
+ Co-Authored-By: Claude <noreply@anthropic.com>
38
+
39
+ # [4.2.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v4.2.0) (2025-06-15)
40
+
41
+ ### Bug Fixes
42
+
43
+ - add docs ([48ef875](https://github.com/bmadcode/BMAD-METHOD/commit/48ef875f5ec5b0f0211baa43bbc04701e54824f4))
44
+ - auto semantic versioning fix ([166ed04](https://github.com/bmadcode/BMAD-METHOD/commit/166ed047671cccab2874fd327efb1ac293ae7276))
45
+ - auto semantic versioning fix again ([11260e4](https://github.com/bmadcode/BMAD-METHOD/commit/11260e43950b6bf78d68c759dc3ac278bc13f8a8))
46
+ - resolve NPM token configuration ([620b09a](https://github.com/bmadcode/BMAD-METHOD/commit/620b09a556ce8d61ad1a4d8ee7c523d263abd69c))
47
+ - resolve NPM token configuration ([b447a8b](https://github.com/bmadcode/BMAD-METHOD/commit/b447a8bd57625d02692d7e2771241bacd120c631))
48
+
49
+ ### Features
50
+
51
+ - update badges to use dynamic NPM version ([5a6fe36](https://github.com/bmadcode/BMAD-METHOD/commit/5a6fe361d085fcaef891a1862fc67878e726949c))
52
+
53
+ # [4.2.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v4.2.0) (2025-06-15)
54
+
55
+ ### Bug Fixes
56
+
57
+ - add docs ([48ef875](https://github.com/bmadcode/BMAD-METHOD/commit/48ef875f5ec5b0f0211baa43bbc04701e54824f4))
58
+ - auto semantic versioning fix ([166ed04](https://github.com/bmadcode/BMAD-METHOD/commit/166ed047671cccab2874fd327efb1ac293ae7276))
59
+ - auto semantic versioning fix again ([11260e4](https://github.com/bmadcode/BMAD-METHOD/commit/11260e43950b6bf78d68c759dc3ac278bc13f8a8))
60
+ - resolve NPM token configuration ([620b09a](https://github.com/bmadcode/BMAD-METHOD/commit/620b09a556ce8d61ad1a4d8ee7c523d263abd69c))
61
+ - resolve NPM token configuration ([b447a8b](https://github.com/bmadcode/BMAD-METHOD/commit/b447a8bd57625d02692d7e2771241bacd120c631))
2
62
 
63
+ ### Features
64
+
65
+ - update badges to use dynamic NPM version ([5a6fe36](https://github.com/bmadcode/BMAD-METHOD/commit/5a6fe361d085fcaef891a1862fc67878e726949c))
66
+
67
+ # [4.2.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v4.2.0) (2025-06-15)
68
+
69
+ ### Bug Fixes
70
+
71
+ - add docs ([48ef875](https://github.com/bmadcode/BMAD-METHOD/commit/48ef875f5ec5b0f0211baa43bbc04701e54824f4))
72
+ - auto semantic versioning fix ([166ed04](https://github.com/bmadcode/BMAD-METHOD/commit/166ed047671cccab2874fd327efb1ac293ae7276))
73
+ - auto semantic versioning fix again ([11260e4](https://github.com/bmadcode/BMAD-METHOD/commit/11260e43950b6bf78d68c759dc3ac278bc13f8a8))
74
+ - resolve NPM token configuration ([620b09a](https://github.com/bmadcode/BMAD-METHOD/commit/620b09a556ce8d61ad1a4d8ee7c523d263abd69c))
75
+ - resolve NPM token configuration ([b447a8b](https://github.com/bmadcode/BMAD-METHOD/commit/b447a8bd57625d02692d7e2771241bacd120c631))
76
+
77
+ ### Features
78
+
79
+ - update badges to use dynamic NPM version ([5a6fe36](https://github.com/bmadcode/BMAD-METHOD/commit/5a6fe361d085fcaef891a1862fc67878e726949c))
80
+
81
+ # [4.2.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v4.2.0) (2025-06-15)
82
+
83
+ ### Bug Fixes
84
+
85
+ - auto semantic versioning fix ([166ed04](https://github.com/bmadcode/BMAD-METHOD/commit/166ed047671cccab2874fd327efb1ac293ae7276))
86
+ - auto semantic versioning fix again ([11260e4](https://github.com/bmadcode/BMAD-METHOD/commit/11260e43950b6bf78d68c759dc3ac278bc13f8a8))
87
+ - resolve NPM token configuration ([620b09a](https://github.com/bmadcode/BMAD-METHOD/commit/620b09a556ce8d61ad1a4d8ee7c523d263abd69c))
88
+ - resolve NPM token configuration ([b447a8b](https://github.com/bmadcode/BMAD-METHOD/commit/b447a8bd57625d02692d7e2771241bacd120c631))
89
+
90
+ ### Features
91
+
92
+ - update badges to use dynamic NPM version ([5a6fe36](https://github.com/bmadcode/BMAD-METHOD/commit/5a6fe361d085fcaef891a1862fc67878e726949c))
93
+
94
+ # [4.2.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v4.2.0) (2025-06-15)
95
+
96
+ ### Bug Fixes
97
+
98
+ - auto semantic versioning fix ([166ed04](https://github.com/bmadcode/BMAD-METHOD/commit/166ed047671cccab2874fd327efb1ac293ae7276))
99
+ - auto semantic versioning fix again ([11260e4](https://github.com/bmadcode/BMAD-METHOD/commit/11260e43950b6bf78d68c759dc3ac278bc13f8a8))
100
+ - resolve NPM token configuration ([620b09a](https://github.com/bmadcode/BMAD-METHOD/commit/620b09a556ce8d61ad1a4d8ee7c523d263abd69c))
101
+ - resolve NPM token configuration ([b447a8b](https://github.com/bmadcode/BMAD-METHOD/commit/b447a8bd57625d02692d7e2771241bacd120c631))
102
+
103
+ ### Features
104
+
105
+ - update badges to use dynamic NPM version ([5a6fe36](https://github.com/bmadcode/BMAD-METHOD/commit/5a6fe361d085fcaef891a1862fc67878e726949c))
106
+
107
+ # [4.2.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.1.0...v4.2.0) (2025-06-15)
108
+
109
+ ### Bug Fixes
110
+
111
+ - auto semantic versioning fix ([166ed04](https://github.com/bmadcode/BMAD-METHOD/commit/166ed047671cccab2874fd327efb1ac293ae7276))
112
+ - auto semantic versioning fix again ([11260e4](https://github.com/bmadcode/BMAD-METHOD/commit/11260e43950b6bf78d68c759dc3ac278bc13f8a8))
113
+ - resolve NPM token configuration ([620b09a](https://github.com/bmadcode/BMAD-METHOD/commit/620b09a556ce8d61ad1a4d8ee7c523d263abd69c))
114
+ - resolve NPM token configuration ([b447a8b](https://github.com/bmadcode/BMAD-METHOD/commit/b447a8bd57625d02692d7e2771241bacd120c631))
115
+
116
+ ### Features
117
+
118
+ - update badges to use dynamic NPM version ([5a6fe36](https://github.com/bmadcode/BMAD-METHOD/commit/5a6fe361d085fcaef891a1862fc67878e726949c))
119
+
120
+ # [1.1.0](https://github.com/bmadcode/BMAD-METHOD/compare/v1.0.1...v1.1.0) (2025-06-15)
3
121
 
4
122
  ### Features
5
123
 
6
- * update badges to use dynamic NPM version ([5a6fe36](https://github.com/bmadcode/BMAD-METHOD/commit/5a6fe361d085fcaef891a1862fc67878e726949c))
124
+ - update badges to use dynamic NPM version ([5a6fe36](https://github.com/bmadcode/BMAD-METHOD/commit/5a6fe361d085fcaef891a1862fc67878e726949c))
7
125
 
8
126
  ## [1.0.1](https://github.com/bmadcode/BMAD-METHOD/compare/v1.0.0...v1.0.1) (2025-06-15)
9
127
 
package/CONTRIBUTING.md CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  Thank you for considering contributing to this project! This document outlines the process for contributing and some guidelines to follow.
4
4
 
5
+ 🆕 **New to GitHub or pull requests?** Check out our [beginner-friendly Pull Request Guide](docs/how-to-contribute-with-pull-requests.md) first!
6
+
5
7
  Also note, we use the discussions feature in GitHub to have a community to discuss potential ideas, uses, additions and enhancements.
6
8
 
7
9
  ## Code of Conduct
package/README.md CHANGED
@@ -241,7 +241,10 @@ Ask the agent you are using for help with /help (in the web) or \*help in the id
241
241
 
242
242
  ## Contributing
243
243
 
244
- We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
244
+ We welcome contributions!
245
+
246
+ - 🆕 **New to GitHub?** Start with our [Pull Request Guide](docs/how-to-contribute-with-pull-requests.md)
247
+ - See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines
245
248
 
246
249
  ### Development Setup
247
250
 
@@ -251,6 +254,21 @@ cd bmad-method
251
254
  npm install
252
255
  ```
253
256
 
257
+ ## Documentation & Guides
258
+
259
+ ### Architecture & Technical
260
+
261
+ - 🏗️ [Core Architecture](docs/core-architecture.md) - Complete technical architecture and system design
262
+ - 📖 [User Guide](docs/user-guide.md) - Comprehensive guide to using BMAD-METHOD effectively
263
+
264
+ ### Workflow Guides
265
+
266
+ - 📚 [Universal BMAD Workflow Guide](docs/bmad-workflow-guide.md) - Core workflow that applies to all IDEs
267
+ - 🎯 [Cursor Guide](docs/cursor-guide.md) - Complete workflow for Cursor users
268
+ - 🤖 [Claude Code Guide](docs/claude-code-guide.md) - Complete workflow for Claude Code users
269
+ - 🌊 [Windsurf Guide](docs/windsurf-guide.md) - Complete workflow for Windsurf users
270
+ - 🦘 [Roo Code Guide](docs/roo-code-guide.md) - Complete workflow for Roo Code users
271
+
254
272
  ## Support
255
273
 
256
274
  - 💬 [Discord Community](https://discord.gg/g6ypHytrCB)
@@ -264,7 +282,7 @@ MIT License - see [LICENSE](LICENSE) for details.
264
282
 
265
283
  ## Version History
266
284
 
267
- - **Current**: [v4.0.0](https://github.com/bmadcode/bmad-method) - Complete framework rewrite with CLI installer, dynamic dependencies, and expansion packs
285
+ - **Current**: [v4](https://github.com/bmadcode/bmad-method) - Complete framework rewrite with CLI installer, dynamic dependencies, and expansion packs
268
286
  - **Previous Versions**:
269
287
  - [Version 3](https://github.com/bmadcode/BMAD-METHOD/tree/V3) - Introduced the unified BMAD Agent and Gemini optimization
270
288
  - [Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2) - Added web agents and template separation
@@ -55,7 +55,7 @@ Determine:
55
55
 
56
56
  **Track Created Items:**
57
57
 
58
- ```
58
+ ```text
59
59
  Created during agent setup:
60
60
  - Tasks:
61
61
  - [ ] task-name-1.md
@@ -104,7 +104,7 @@ Ensure:
104
104
 
105
105
  Present to the user:
106
106
 
107
- ```
107
+ ```text
108
108
  ✅ Agent Created: [agent-name]
109
109
  Location: .bmad-core/agents/[agent-id].md
110
110
 
@@ -136,23 +136,21 @@ The agent template structure:
136
136
 
137
137
  ## Example Usage
138
138
 
139
- ```yaml
139
+ ````yaml
140
140
  agent:
141
141
  name: Data Analyst
142
142
  id: data-analyst
143
143
  title: Data Analysis Specialist
144
-
145
144
  persona:
146
145
  role: Expert in data analysis, visualization, and insights extraction
147
146
  style: analytical, data-driven, clear, methodical
148
147
  identity: I am a seasoned data analyst who transforms raw data into actionable insights
149
148
  focus: data exploration, statistical analysis, visualization, reporting
150
-
151
149
  core_principles:
152
150
  - Data integrity and accuracy above all
153
151
  - Clear communication of complex findings
154
152
  - Actionable insights over raw numbers
155
- ```
153
+ ```text
156
154
 
157
155
  ## Creating Missing Dependencies
158
156
 
@@ -185,13 +183,13 @@ When a required task or template doesn't exist:
185
183
  ```yaml
186
184
  dependencies:
187
185
  tasks:
188
- - create-doc # Required if agent creates any documents
189
- - analyze-requirements # Custom task for this agent
190
- - generate-report # Another custom task
186
+ - 'create-doc # Required if agent creates any documents'
187
+ - 'analyze-requirements # Custom task for this agent'
188
+ - 'generate-report # Another custom task'
191
189
  templates:
192
- - requirements-doc # Template for requirements documents
193
- - analysis-report # Template for analysis reports
194
- ```
190
+ - 'requirements-doc # Template for requirements documents'
191
+ - 'analysis-report # Template for analysis reports'
192
+ ````
195
193
 
196
194
  ## Notes
197
195
 
@@ -43,7 +43,7 @@ IMPORTANT: STOP HERE AND CREATE PLAN FIRST
43
43
 
44
44
  Create `expansion-packs/{pack-name}/plan.md` with:
45
45
 
46
- ```markdown
46
+ ````markdown
47
47
  # {Pack Name} Expansion Pack Plan
48
48
 
49
49
  ## Overview
@@ -83,7 +83,8 @@ Create `expansion-packs/{pack-name}/plan.md` with:
83
83
  ## Approval
84
84
 
85
85
  User approval received: [ ] Yes
86
- ```
86
+
87
+ ````text
87
88
 
88
89
  Important: Wait for user approval before proceeding to Phase 2
89
90
 
@@ -167,13 +168,14 @@ expansion-packs/
167
168
  └── ide-agents/
168
169
  ├── {pack-name}-orchestrator.ide.md (REQUIRED)
169
170
  └── {agent-id}.ide.md
170
- ```
171
+ ````
172
+ ````
171
173
 
172
174
  #### 3.2 Create Manifest
173
175
 
174
176
  Create `manifest.yml`:
175
177
 
176
- ```yaml
178
+ ````yaml
177
179
  name: {pack-name}
178
180
  version: 1.0.0
179
181
  description: >-
@@ -223,7 +225,7 @@ post_install_message: |
223
225
  - {data-file}.{ext}: {description}
224
226
 
225
227
  To use: npm run agent {pack-name}-orchestrator
226
- ```
228
+ ```text
227
229
 
228
230
  ### Phase 4: Content Creation
229
231
 
@@ -306,7 +308,7 @@ For each required data file:
306
308
  - **Format**: {file format and structure}
307
309
  - **Location**: Place in `bmad-core/data/`
308
310
  - **Example**:
309
- ```
311
+ ````
310
312
 
311
313
  ## Example: Healthcare Expansion Pack
312
314