@sleighmaster/bmad 1.5.2 → 1.5.4

package/data/_bmad/_config/bmad-help.csv

@@ -22,6 +22,7 @@ bmm,4-implementation,Dev Story,DS,40,_bmad/bmm/workflows/4-implementation/dev-st
 bmm,4-implementation,Automate,QA,45,_bmad/bmm/workflows/qa/automate/workflow.yaml,bmad-bmm-automate,false,quinn,bmad:bmm:agent:quinn,Quinn,🧪 QA Engineer,Create Mode,"Generate automated API and E2E tests for implemented code using the project's existing test framework (detects Playwright, Jest, Vitest, etc). 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,Code Review,CR,50,_bmad/bmm/workflows/4-implementation/code-review/workflow.yaml,bmad-bmm-code-review,false,dev,bmad:_bmad/bmm/agents/dev.md:agent:dev,Amelia,💻 Developer Agent,Create Mode,Story cycle: If issues back to DS if approved then next CS or ER if epic complete,,
 bmm,4-implementation,Retrospective,ER,60,_bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml,bmad-bmm-retrospective,false,sm,bmad:- I strive to be a servant leader and conduct myself accordingly:agent:sm,Bob,🏃 Scrum Master,Create Mode,Optional at epic end: Review completed work lessons learned and next epic or if major issues consider CC,implementation_artifacts,retrospective
+bmm,anytime,Developer Onboarding,DO,5,_bmad/bmm/workflows/onboarding/workflow.md,bmad-bmm-onboarding,false,,,,,Create Mode,Generate comprehensive onboarding documentation for new developers joining the project,output_folder,onboarding guide
 bmm,anytime,Document Project,DP,10,_bmad/bmm/workflows/document-project/workflow.yaml,bmad-bmm-document-project,false,analyst,bmad:- Channel expert business analysis frameworks: draw upon Porter's Five Forces:agent:analyst,Mary,📊 Business Analyst,Create Mode,Analyze an existing project to produce useful documentation,project-knowledge,*
 bmm,anytime,Quick Spec,TS,20,_bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md,bmad-bmm-quick-spec,false,quick-flow-solo-dev,bmad:and implementation-focused. Uses tech slang (e.g.:agent:quick-flow-solo-dev,Barry,🚀 Quick Flow Solo Dev,Create Mode,Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method. Quick one-off tasks small changes simple apps utilities without extensive planning,planning_artifacts,tech spec
 bmm,anytime,Quick Dev,QD,30,_bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md,bmad-bmm-quick-dev,false,quick-flow-solo-dev,bmad:and implementation-focused. Uses tech slang (e.g.:agent:quick-flow-solo-dev,Barry,🚀 Quick Flow Solo Dev,Create Mode,"Quick one-off tasks small changes simple apps utilities without extensive planning - Do not suggest for potentially very complex things unless requested or if the user complains that they do not want to follow the extensive planning of the bmad method, unless the user is already working through the implementation phase and just requests a 1 off things not already in the plan",,

package/data/_bmad/_config/workflow-manifest.csv

@@ -22,4 +22,5 @@ name,description,module,path
 "create-excalidraw-diagram","Create system architecture diagrams, ERDs, UML diagrams, or general technical diagrams in Excalidraw format","bmm","_bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml"
 "create-excalidraw-flowchart","Create a flowchart visualization in Excalidraw format for processes, pipelines, or logic flows","bmm","_bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml"
 "create-excalidraw-wireframe","Create website or app wireframes in Excalidraw format","bmm","_bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml"
+"onboarding","Generate a comprehensive onboarding document for new developers joining this project.","bmm","_bmad/bmm/workflows/onboarding/workflow.md"
 "qa-automate","Generate tests quickly for existing features using standard test patterns","bmm","_bmad/bmm/workflows/qa/automate/workflow.yaml"

package/data/_bmad/bmm/data/changelog/cliff.toml

@@ -1,14 +1,17 @@
 # git-cliff configuration for CHANGELOG generation
 # https://git-cliff.org
+#
+# Follows "Keep a Changelog" (https://keepachangelog.com) conventions
+# Only user-facing changes are included. Internal dev details are filtered out.
 
 [changelog]
-header = "# Changelog\n\n"
+header = "# Changelog\n\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com),\nand this project adheres to [Semantic Versioning](https://semver.org).\n\n"
 body = """
 ## [{{ version }}] - {{ timestamp | date(format="%Y-%m-%d") }}
 {% for group, commits in commits | group_by(attribute="group") %}
 ### {{ group | upper_first }}
 {% for commit in commits %}
-- {{ commit.message | split(pat="\n") | first }}
+- {{ commit.message | split(pat="\n") | first | trim_start_matches(pat="feat: ") | trim_start_matches(pat="feat(") | trim_start_matches(pat="fix: ") | trim_start_matches(pat="fix(") }}
 {%- endfor %}
 {% endfor %}
 
@@ -20,13 +23,33 @@ trim = true
 conventional_commits = true
 filter_unconventional = true
 commit_parsers = [
+  # --- Skip: internal/noise commits ---
   { message = "^docs: update CHANGELOG", skip = true },
-  { message = "^feat", group = "Features" },
-  { message = "^fix", group = "Bug Fixes" },
-  { message = "^docs", group = "Documentation" },
-  { message = "^refactor", group = "Refactor" },
-  { message = "^test", group = "Testing" },
-  { message = "^chore", group = "Miscellaneous" },
+  { message = "^chore: release", skip = true },
+  { message = "^chore\\(release\\)", skip = true },
+  { message = "^bump version", skip = true },
+  { message = "^\\d+\\.\\d+\\.\\d+", skip = true },
+  { message = "\\[skip ci\\]", skip = true },
+  { message = "^Merge", skip = true },
+  { message = "^merge", skip = true },
+  { message = "^sync package", skip = true },
+  { message = "^chore: bump", skip = true },
+  { message = "^chore: sync", skip = true },
+  { message = "^style", skip = true },
+  { message = "^ci", skip = true },
+  { message = "^build", skip = true },
+  { message = "^test", skip = true },
+  { message = "^docs", skip = true },
+  { message = "^chore", skip = true },
+  { message = "^refactor", skip = true },
+  # --- Include: user-facing changes only ---
+  { message = "^feat", group = "Added" },
+  { message = "^fix", group = "Fixed" },
+  { message = "^hotfix", group = "Fixed" },
+  { message = "^perf", group = "Changed" },
+  { message = "^revert", group = "Removed" },
+  # Breaking changes (from footer or ! suffix)
+  { body = "BREAKING.CHANGE", group = "Breaking Changes" },
 ]
 filter_commits = false
 tag_pattern = "v[0-9]*"

package/data/_bmad/bmm/workflows/4-implementation/create-story/instructions.xml

@@ -198,6 +198,26 @@
     all learnings that could impact current story implementation</action>
     </check>
 
+    <!-- Retrospective intelligence for learning propagation -->
+    <action>Check if {retrospectives_folder} exists and contains retrospective documents</action>
+    <check if="retrospective documents found in {retrospectives_folder}">
+      <action>Scan {retrospectives_folder} for files matching pattern: epic-*-retro-*.md</action>
+      <action>Sort by epic number descending, load the most recent retrospective(s) relevant to current epic</action>
+      <action>If current epic_num > 1, prioritize loading epic-{{prev_epic_num}}-retro-*.md (immediately preceding epic)</action>
+
+      **RETROSPECTIVE INTELLIGENCE:**
+      <action>Extract from each loaded retrospective:
+        - **Action Items**: Specific agreed-upon changes and their ownership
+        - **Team Agreements**: Process or coding conventions the team committed to
+        - **Recurring Patterns**: Issues that appeared multiple times across stories
+        - **Code Review Findings**: H/M-level issues that were repeatedly flagged
+        - **Lessons Learned**: Key insights about what worked and what didn't
+        - **Anti-Patterns Identified**: Specific mistakes to avoid going forward
+      </action>
+      <action>Filter extracted items for relevance to current story's domain and technical area</action>
+      <action>Flag any unresolved action items that directly apply to this story's implementation</action>
+    </check>
+
     <!-- Git intelligence for previous work patterns -->
     <check
       if="previous story exists AND git repository detected">
@@ -278,6 +298,12 @@
     file_structure_requirements</template-output>
     <template-output file="{default_output_file}">testing_requirements</template-output>
 
+    <!-- Retrospective learnings -->
+    <check
+      if="retrospective analysis completed AND relevant items found">
+      <template-output file="{default_output_file}">retrospective_learnings</template-output>
+    </check>
+
     <!-- Previous story intelligence -->
     <check
       if="previous story learnings available">

package/data/_bmad/bmm/workflows/4-implementation/create-story/template.md

@@ -38,6 +38,14 @@ so that {{benefit}}.
 - Source tree components to touch
 - Testing standards summary
 
+### Retrospective Learnings
+
+<!-- Auto-populated from previous epic retrospectives when available -->
+
+- Relevant action items from previous retrospectives
+- Recurring code review patterns to watch for
+- Team agreements applicable to this story
+
 ### Project Structure Notes
 
 - Alignment with unified project structure (paths, modules, naming)

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

@@ -15,6 +15,7 @@ architecture_artifacts: "{config_source}:architecture_artifacts"
 implementation_artifacts: "{config_source}:implementation_artifacts"
 output_folder: "{implementation_artifacts}"
 story_dir: "{stories_artifacts}"
+retrospectives_folder: "{implementation_artifacts}/retrospectives"
 
 # Workflow components
 installed_path: "{project-root}/_bmad/bmm/workflows/4-implementation/create-story"
@@ -61,5 +62,9 @@ input_file_patterns:
     whole: "{epics_artifacts}/*epic*.md"
     sharded: "{epics_artifacts}/*epic*/*.md"
     load_strategy: "SELECTIVE_LOAD" # Only load needed epic
+  retrospective:
+    description: "Previous epic retrospectives for lessons learned and action items"
+    pattern: "{retrospectives_folder}/epic-*-retro-*.md"
+    load_strategy: "SELECTIVE_LOAD" # Load most recent retrospective(s)
 
 standalone: true

package/data/_bmad/bmm/workflows/onboarding/onboarding-template.md

@@ -0,0 +1,167 @@
+# {project_name} — Developer Onboarding Guide
+
+> Generated: {date}
+
+---
+
+## 1. Project Overview
+
+<!-- PLACEHOLDER: project_overview -->
+<!-- Fill with: project name, description/purpose, version, license -->
+<!-- Include a tech stack summary table:
+| Category | Technology |
+|----------|-----------|
+| Language | ... |
+| Framework | ... |
+| Database | ... |
+| Test Framework | ... |
+| Build Tool | ... |
+-->
+
+---
+
+## 2. Project Structure
+
+<!-- PLACEHOLDER: project_structure -->
+<!-- Fill with: 2-level directory tree with descriptions -->
+<!-- Example format:
+```
+project-root/
+├── src/           — Source code
+├── tests/         — Test suites
+└── docs/          — Documentation
+```
+-->
+
+---
+
+## 3. Development Environment Setup
+
+### Prerequisites
+
+<!-- PLACEHOLDER: prerequisites -->
+<!-- Fill with: required tools and versions (Node.js, Python, Docker, etc.) -->
+
+### Getting Started
+
+<!-- PLACEHOLDER: getting_started -->
+<!-- Fill with: step-by-step commands to set up and run the project -->
+<!-- Example format:
+```bash
+# Clone the repository
+git clone <repo-url>
+cd <project-name>
+
+# Install dependencies
+npm install
+
+# Run development server
+npm run dev
+
+# Run tests
+npm test
+```
+-->
+
+---
+
+## 4. Development Workflow
+
+### Git Workflow
+
+<!-- PLACEHOLDER: git_workflow -->
+<!-- Fill with: branch strategy, commit conventions, PR process -->
+
+### Code Standards
+
+<!-- PLACEHOLDER: code_standards -->
+<!-- Fill with: linter/formatter config, key coding rules from CLAUDE.md -->
+
+### Testing
+
+<!-- PLACEHOLDER: testing -->
+<!-- Fill with: test framework, how to run tests, coverage requirements -->
+
+### CI/CD
+
+<!-- PLACEHOLDER: cicd -->
+<!-- Fill with: pipeline descriptions, deployment process -->
+
+---
+
+## 5. Current Project Status
+
+### Planning Documents
+
+<!-- PLACEHOLDER: planning_documents -->
+<!-- Fill with: list of existing planning artifacts (PRD, Architecture, UX, etc.) with file paths -->
+
+### Epic & Story Progress
+
+<!-- PLACEHOLDER: epic_story_progress -->
+<!-- Fill with: sprint status summary — epic/story counts, completion rates, current focus -->
+<!-- If no epics exist, note that the project is in pre-implementation or uses a different tracking method -->
+
+---
+
+## 6. BMAD Workflow Guide
+
+<!-- PLACEHOLDER: bmad_section -->
+<!-- If BMAD is not installed, replace this entire section with a note that BMAD is not configured for this project -->
+
+### What is BMAD?
+
+<!-- PLACEHOLDER: bmad_intro -->
+<!-- Brief 2-3 sentence explanation of BMAD Method and what it provides -->
+
+### Daily Commands (Top 6)
+
+<!-- PLACEHOLDER: bmad_daily_commands -->
+<!-- Fill with table:
+| Command | Description |
+|---------|-----------|
+| `/bmad-help` | Get unstuck — shows next steps and answers questions |
+| `/bmad-bmm-quick-dev` | Quick one-off tasks without full planning |
+| `/bmad-bmm-sprint-status` | View current sprint progress |
+| `/bmad-bmm-dev-story` | Execute the next story implementation |
+| `/bmad-bmm-document-project` | Generate project documentation |
+| `/bmad-bmm-onboarding` | Regenerate this onboarding guide |
+-->
+
+### Full Workflow Phases
+
+<!-- PLACEHOLDER: bmad_workflow_phases -->
+<!-- Fill with the phase-ordered workflow from bmad-help.csv:
+1. Analysis — Brainstorm, Research, Create Brief
+2. Planning — PRD, UX Design
+3. Solutioning — Architecture, Epics & Stories, Readiness Check
+4. Implementation — Sprint Planning, Create Story, Dev Story, Code Review
+-->
+
+---
+
+## 7. Reference Documents
+
+<!-- PLACEHOLDER: reference_documents -->
+<!-- Fill with: links to existing documentation files -->
+<!-- Example format:
+- [Project Overview](./project-overview.md)
+- [Source Tree](./source-tree.md)
+- [Architecture](./architecture.md)
+-->
+<!-- If no documents exist, note that documentation can be generated with `/bmad-bmm-document-project` -->
+
+---
+
+## 8. Quick Start Checklist
+
+<!-- PLACEHOLDER: quick_start_checklist -->
+<!-- Fill with actionable checklist. Example:
+- [ ] Clone repo and install dependencies
+- [ ] Run the project locally
+- [ ] Run the test suite
+- [ ] Read CLAUDE.md for project rules
+- [ ] Check sprint status: `/bmad-bmm-sprint-status`
+- [ ] Review current epic/story assignments
+- [ ] Pick up your first story: `/bmad-bmm-create-story`
+-->

package/data/_bmad/bmm/workflows/onboarding/workflow.md

@@ -0,0 +1,226 @@
+---
+name: onboarding
+description: 'Generate a comprehensive onboarding document for new developers joining this project.'
+---
+
+# Developer Onboarding Document Generator
+
+**Goal:** Automatically scan the project and generate a single, comprehensive onboarding guide for new developers joining the team.
+
+**Your Role:** You are a technical writer creating a human-readable onboarding document. Scan project metadata, structure, and configuration — do NOT deep-dive into source code. Produce a clear, actionable guide that helps a new developer get productive quickly.
+
+---
+
+## INITIALIZATION
+
+### Configuration Loading
+
+Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
+
+- `project_name`, `user_name`, `communication_language`, `document_output_language`
+- `output_folder`, `planning_artifacts`, `implementation_artifacts`, `epics_artifacts`
+- `date` = current date
+
+### Path Variables
+
+- `installed_path` = `{project-root}/_bmad/bmm/workflows/onboarding`
+- `template_path` = `{installed_path}/onboarding-template.md`
+- `output_path` = `{output_folder}/onboarding-guide.md`
+- `bmad_config_path` = `{project-root}/_bmad/_config`
+
+### Critical Rules
+
+- **ALL output text** (section headings, descriptions, explanations) MUST be written in `{document_output_language}`
+- Translate template section titles and placeholder text to `{document_output_language}`
+- If `onboarding-guide.md` already exists at `output_path`, overwrite it (re-run = refresh)
+- Do NOT deep-scan source code files — focus on metadata, config, and structure
+
+---
+
+## PHASE 1: PROJECT FUNDAMENTALS
+
+### 1.1 Repository Basics
+
+Scan and collect:
+
+- **README.md** — extract project name, description, purpose (first ~50 lines)
+- **package.json** / **pyproject.toml** / **Cargo.toml** / equivalent — name, version, description, scripts
+- **LICENSE** — license type
+- **Git info** — default branch, remote URL
+
+### 1.2 Tech Stack Detection
+
+From dependency files (package.json, requirements.txt, go.mod, etc.):
+
+- **Languages** — primary language(s) and versions
+- **Frameworks** — web framework, UI library, test framework
+- **Key Dependencies** — database, ORM, auth, API client, etc.
+- **Dev Tools** — linter, formatter, bundler, task runner
+
+### 1.3 Project Structure
+
+Generate a **2-level directory tree** of the project root with brief descriptions:
+
+```
+project-root/
+├── src/           — Source code
+├── tests/         — Test suites
+├── docs/          — Documentation
+├── _bmad/         — BMAD Method configuration
+└── ...
+```
+
+### 1.4 Development Environment Setup
+
+Extract from README, package.json scripts, Makefile, docker-compose, etc.:
+
+- **Prerequisites** — Node.js version, Python version, Docker, etc.
+- **Install command** — `npm install`, `pip install`, etc.
+- **Run command** — `npm run dev`, `python manage.py runserver`, etc.
+- **Test command** — `npm test`, `pytest`, etc.
+- **Build command** — if applicable
+
+---
+
+## PHASE 2: DEVELOPMENT WORKFLOW
+
+### 2.1 Git Workflow
+
+Scan for:
+
+- **Git hooks** — `.husky/`, `_bmad/hooks/`, `.git/hooks/` — list active hooks and what they do
+- **Branch strategy** — from CONTRIBUTING.md, CLAUDE.md, or PR templates
+- **PR templates** — `.github/pull_request_template.md`
+- **CI/CD** — `.github/workflows/`, `.gitlab-ci.yml`, `Jenkinsfile` — list pipelines and their purpose
+
+### 2.2 Code Standards
+
+Scan for:
+
+- **Linter config** — `.eslintrc`, `ruff.toml`, `.golangci.yml`, etc.
+- **Formatter config** — `.prettierrc`, `black`, `gofmt`, etc.
+- **CLAUDE.md rules** — extract key development rules from CLAUDE.md if it exists
+- **EditorConfig** — `.editorconfig` settings
+
+### 2.3 Test Strategy
+
+Detect:
+
+- **Test framework** — Jest, Vitest, Pytest, Go test, etc.
+- **Test directory** — where tests live
+- **Test run command** — how to execute tests
+- **Coverage** — coverage tool and thresholds if configured
+
+### 2.4 Build & Deploy
+
+Detect:
+
+- **Build system** — webpack, vite, turbo, make, etc.
+- **Build command** — primary build command
+- **Environments** — dev, staging, production indicators
+- **Deployment** — Dockerfile, Vercel config, AWS config, etc.
+
+---
+
+## PHASE 3: BMAD WORKFLOW (Conditional)
+
+> **If `{project-root}/_bmad/` directory does NOT exist, skip this entire phase and note in the output that BMAD is not installed.**
+
+### 3.1 BMAD Installation Detection
+
+- Confirm `_bmad/` exists
+- Load `_bmad/bmm/config.yaml` if present (already loaded in INIT)
+- Detect installed modules: check for `_bmad/core/`, `_bmad/bmm/`
+
+### 3.2 Available Commands
+
+Scan `{project-root}/.claude/commands/bmad-*.md`:
+
+- List each command with its name and description (from frontmatter)
+- Group by category if possible (analysis, planning, implementation, anytime)
+
+### 3.3 Workflow Guide
+
+Load `{bmad_config_path}/bmad-help.csv`:
+
+- Extract the **phase-ordered workflow sequence** (phase 1 → 2 → 3 → 4)
+- For the `anytime` group, highlight the **top daily-use commands**:
+  - `/bmad-help` — Get unstuck
+  - `/bmad-bmm-quick-dev` — Quick tasks
+  - `/bmad-bmm-sprint-status` — Sprint overview
+  - `/bmad-bmm-document-project` — Generate docs
+  - `/bmad-bmm-onboarding` — Refresh this guide
+- Create a simple "your first day" command sequence recommendation
+
+---
+
+## PHASE 4: PROJECT STATUS
+
+### 4.1 Planning Artifacts
+
+Check for existence of key documents in `{planning_artifacts}`:
+
+- PRD (`*prd*`, `*product-requirements*`)
+- Architecture doc (`*architecture*`, `*arch*`)
+- UX design (`*ux*`, `*design*`)
+- Product brief (`*brief*`)
+- List found documents with relative paths
+
+### 4.2 Epic & Story Status
+
+If `{epics_artifacts}` exists:
+
+- List epic files found (`epic-*.md`)
+- If `sprint-status.yaml` exists in `{implementation_artifacts}`, parse and summarize:
+  - Total epics, stories
+  - Completion status (done / in-progress / pending counts)
+  - Current sprint focus
+
+### 4.3 Existing Documentation
+
+Check `{output_folder}` for document-project outputs:
+
+- `project-overview.md`
+- `source-tree.md`
+- `*-deep-dive.md`
+- Any `index.md` files
+- List found documents as reference links (do NOT duplicate content)
+
+---
+
+## PHASE 5: DOCUMENT GENERATION
+
+### 5.1 Load Template
+
+Read the full template from `{template_path}`.
+
+### 5.2 Fill Template
+
+Replace all placeholder sections with the data collected in Phases 1-4:
+
+- Every `<!-- PLACEHOLDER: ... -->` must be replaced with actual content
+- Remove any placeholder comments that have no data (section stays but shows "Not detected" or equivalent in `{document_output_language}`)
+- Translate ALL fixed text (section titles, labels, descriptions) to `{document_output_language}`
+- Keep code blocks, file paths, and command names in their original form
+
+### 5.3 Write Output
+
+Save the completed document to `{output_path}`.
+
+### 5.4 Completion Summary
+
+Output to the user:
+
+```
+✅ Onboarding guide generated: {output_path}
+
+Sections included:
+- Project Overview
+- Project Structure
+- Dev Environment Setup
+- Development Workflow
+- [BMAD Workflow — if applicable]
+- Project Status
+- Reference Documents
+- Quick Start Checklist
+```

package/data/claude-commands/bmad-bmm-onboarding.md

@@ -0,0 +1,6 @@
+---
+name: 'onboarding'
+description: 'Generate a comprehensive onboarding document for new developers joining this project.'
+---
+
+IT IS CRITICAL THAT YOU FOLLOW THIS COMMAND: LOAD the FULL @{project-root}/_bmad/bmm/workflows/onboarding/workflow.md, READ its entire contents and follow its directions exactly!

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sleighmaster/bmad",
-  "version": "1.5.2",
+  "version": "1.5.4",
   "description": "BMad6GitHub CLI - BMAD + GitHub Integration installer",
   "type": "module",
   "bin": {