bmad-method 6.3.1-next.8 → 6.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.
- package/package.json +3 -2
- package/src/bmm-skills/1-analysis/bmad-agent-analyst/SKILL.md +51 -36
- package/src/bmm-skills/1-analysis/bmad-agent-analyst/customize.toml +90 -0
- package/src/bmm-skills/1-analysis/bmad-agent-tech-writer/SKILL.md +50 -33
- package/src/bmm-skills/1-analysis/bmad-agent-tech-writer/customize.toml +81 -0
- package/src/bmm-skills/1-analysis/bmad-document-project/SKILL.md +57 -1
- package/src/bmm-skills/1-analysis/bmad-document-project/customize.toml +41 -0
- package/src/bmm-skills/1-analysis/bmad-document-project/workflows/deep-dive-instructions.md +1 -0
- package/src/bmm-skills/1-analysis/bmad-document-project/workflows/full-scan-instructions.md +1 -0
- package/src/bmm-skills/1-analysis/bmad-prfaq/SKILL.md +48 -9
- package/src/bmm-skills/1-analysis/bmad-prfaq/customize.toml +41 -0
- package/src/bmm-skills/1-analysis/bmad-prfaq/references/verdict.md +4 -0
- package/src/bmm-skills/1-analysis/bmad-product-brief/SKILL.md +44 -9
- package/src/bmm-skills/1-analysis/bmad-product-brief/customize.toml +47 -0
- package/src/bmm-skills/1-analysis/bmad-product-brief/prompts/contextual-discovery.md +8 -7
- package/src/bmm-skills/1-analysis/bmad-product-brief/prompts/draft-and-review.md +6 -5
- package/src/bmm-skills/1-analysis/bmad-product-brief/prompts/finalize.md +4 -1
- package/src/bmm-skills/1-analysis/bmad-product-brief/prompts/guided-elicitation.md +3 -2
- package/src/bmm-skills/1-analysis/research/bmad-domain-research/SKILL.md +91 -1
- package/src/bmm-skills/1-analysis/research/bmad-domain-research/customize.toml +41 -0
- package/src/bmm-skills/1-analysis/research/bmad-domain-research/domain-steps/step-06-research-synthesis.md +6 -0
- package/src/bmm-skills/1-analysis/research/bmad-market-research/SKILL.md +91 -1
- package/src/bmm-skills/1-analysis/research/bmad-market-research/customize.toml +41 -0
- package/src/bmm-skills/1-analysis/research/bmad-market-research/steps/step-06-research-completion.md +6 -0
- package/src/bmm-skills/1-analysis/research/bmad-technical-research/SKILL.md +91 -1
- package/src/bmm-skills/1-analysis/research/bmad-technical-research/customize.toml +41 -0
- package/src/bmm-skills/1-analysis/research/bmad-technical-research/technical-steps/step-06-research-synthesis.md +6 -0
- package/src/bmm-skills/2-plan-workflows/bmad-agent-pm/SKILL.md +50 -35
- package/src/bmm-skills/2-plan-workflows/bmad-agent-pm/customize.toml +85 -0
- package/src/bmm-skills/2-plan-workflows/bmad-agent-ux-designer/SKILL.md +50 -31
- package/src/bmm-skills/2-plan-workflows/bmad-agent-ux-designer/customize.toml +60 -0
- package/src/bmm-skills/2-plan-workflows/bmad-create-prd/SKILL.md +99 -1
- package/src/bmm-skills/2-plan-workflows/bmad-create-prd/customize.toml +41 -0
- package/src/bmm-skills/2-plan-workflows/bmad-create-prd/steps-c/step-12-complete.md +6 -0
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/SKILL.md +70 -1
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/customize.toml +41 -0
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/steps/step-14-complete.md +6 -0
- package/src/bmm-skills/2-plan-workflows/bmad-edit-prd/SKILL.md +97 -1
- package/src/bmm-skills/2-plan-workflows/bmad-edit-prd/customize.toml +42 -0
- package/src/bmm-skills/2-plan-workflows/bmad-edit-prd/steps-e/step-e-04-complete.md +2 -0
- package/src/bmm-skills/2-plan-workflows/bmad-validate-prd/SKILL.md +99 -1
- package/src/bmm-skills/2-plan-workflows/bmad-validate-prd/customize.toml +42 -0
- package/src/bmm-skills/2-plan-workflows/bmad-validate-prd/steps-v/step-v-13-report-complete.md +1 -0
- package/src/bmm-skills/3-solutioning/bmad-agent-architect/SKILL.md +50 -30
- package/src/bmm-skills/3-solutioning/bmad-agent-architect/customize.toml +65 -0
- package/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/SKILL.md +86 -1
- package/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/customize.toml +41 -0
- package/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/steps/step-06-final-assessment.md +6 -0
- package/src/bmm-skills/3-solutioning/bmad-create-architecture/SKILL.md +69 -1
- package/src/bmm-skills/3-solutioning/bmad-create-architecture/customize.toml +41 -0
- package/src/bmm-skills/3-solutioning/bmad-create-architecture/steps/step-08-complete.md +6 -0
- package/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/SKILL.md +88 -1
- package/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/customize.toml +41 -0
- package/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/steps/step-04-final-validation.md +6 -0
- package/src/bmm-skills/3-solutioning/bmad-generate-project-context/SKILL.md +76 -1
- package/src/bmm-skills/3-solutioning/bmad-generate-project-context/customize.toml +41 -0
- package/src/bmm-skills/3-solutioning/bmad-generate-project-context/steps/step-03-complete.md +6 -0
- package/src/bmm-skills/4-implementation/bmad-agent-dev/SKILL.md +48 -43
- package/src/bmm-skills/4-implementation/bmad-agent-dev/customize.toml +90 -0
- package/src/bmm-skills/4-implementation/bmad-checkpoint-preview/SKILL.md +46 -7
- package/src/bmm-skills/4-implementation/bmad-checkpoint-preview/customize.toml +41 -0
- package/src/bmm-skills/4-implementation/bmad-checkpoint-preview/step-05-wrapup.md +6 -0
- package/src/bmm-skills/4-implementation/bmad-code-review/SKILL.md +85 -1
- package/src/bmm-skills/4-implementation/bmad-code-review/customize.toml +41 -0
- package/src/bmm-skills/4-implementation/bmad-code-review/steps/step-04-present.md +6 -0
- package/src/bmm-skills/4-implementation/bmad-correct-course/SKILL.md +296 -1
- package/src/bmm-skills/4-implementation/bmad-correct-course/customize.toml +41 -0
- package/src/bmm-skills/4-implementation/bmad-create-story/SKILL.md +424 -1
- package/src/bmm-skills/4-implementation/bmad-create-story/customize.toml +41 -0
- package/src/bmm-skills/4-implementation/bmad-dev-story/SKILL.md +480 -1
- package/src/bmm-skills/4-implementation/bmad-dev-story/customize.toml +41 -0
- package/src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests/SKILL.md +171 -1
- package/src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests/customize.toml +41 -0
- package/src/bmm-skills/4-implementation/bmad-quick-dev/SKILL.md +106 -1
- package/src/bmm-skills/4-implementation/bmad-quick-dev/customize.toml +41 -0
- package/src/bmm-skills/4-implementation/bmad-quick-dev/step-05-present.md +6 -0
- package/src/bmm-skills/4-implementation/bmad-quick-dev/step-oneshot.md +6 -0
- package/src/bmm-skills/4-implementation/bmad-retrospective/SKILL.md +1507 -1
- package/src/bmm-skills/4-implementation/bmad-retrospective/customize.toml +41 -0
- package/src/bmm-skills/4-implementation/bmad-sprint-planning/SKILL.md +294 -1
- package/src/bmm-skills/4-implementation/bmad-sprint-planning/customize.toml +41 -0
- package/src/bmm-skills/4-implementation/bmad-sprint-status/SKILL.md +292 -1
- package/src/bmm-skills/4-implementation/bmad-sprint-status/customize.toml +41 -0
- package/src/bmm-skills/module.yaml +49 -0
- package/src/core-skills/bmad-advanced-elicitation/SKILL.md +7 -1
- package/src/core-skills/bmad-customize/SKILL.md +111 -0
- package/src/core-skills/bmad-customize/scripts/list_customizable_skills.py +231 -0
- package/src/core-skills/bmad-customize/scripts/tests/test_list_customizable_skills.py +249 -0
- package/src/core-skills/bmad-distillator/resources/distillate-format-reference.md +1 -1
- package/src/core-skills/bmad-party-mode/SKILL.md +13 -10
- package/src/core-skills/module-help.csv +1 -0
- package/src/core-skills/module.yaml +2 -0
- package/src/scripts/resolve_config.py +176 -0
- package/src/scripts/resolve_customization.py +230 -0
- package/tools/installer/commands/install.js +13 -0
- package/tools/installer/core/config.js +4 -1
- package/tools/installer/core/install-paths.js +11 -5
- package/tools/installer/core/installer.js +181 -94
- package/tools/installer/core/manifest-generator.js +339 -184
- package/tools/installer/core/manifest.js +86 -86
- package/tools/installer/fs-native.js +5 -0
- package/tools/installer/ide/platform-codes.yaml +6 -0
- package/tools/installer/modules/channel-plan.js +203 -0
- package/tools/installer/modules/channel-resolver.js +241 -0
- package/tools/installer/modules/community-manager.js +130 -23
- package/tools/installer/modules/custom-module-manager.js +160 -19
- package/tools/installer/modules/external-manager.js +235 -32
- package/tools/installer/modules/official-modules.js +58 -12
- package/tools/installer/modules/registry-client.js +139 -7
- package/tools/installer/modules/registry-fallback.yaml +8 -0
- package/tools/installer/modules/version-resolver.js +336 -0
- package/tools/installer/project-root.js +54 -0
- package/tools/installer/ui.js +561 -50
- package/tools/platform-codes.yaml +6 -0
- package/src/bmm-skills/1-analysis/bmad-agent-analyst/bmad-skill-manifest.yaml +0 -11
- package/src/bmm-skills/1-analysis/bmad-agent-tech-writer/bmad-skill-manifest.yaml +0 -11
- package/src/bmm-skills/1-analysis/bmad-document-project/workflow.md +0 -25
- package/src/bmm-skills/1-analysis/research/bmad-domain-research/workflow.md +0 -51
- package/src/bmm-skills/1-analysis/research/bmad-market-research/workflow.md +0 -51
- package/src/bmm-skills/1-analysis/research/bmad-technical-research/workflow.md +0 -52
- package/src/bmm-skills/2-plan-workflows/bmad-agent-pm/bmad-skill-manifest.yaml +0 -11
- package/src/bmm-skills/2-plan-workflows/bmad-agent-ux-designer/bmad-skill-manifest.yaml +0 -11
- package/src/bmm-skills/2-plan-workflows/bmad-create-prd/workflow.md +0 -61
- package/src/bmm-skills/2-plan-workflows/bmad-create-ux-design/workflow.md +0 -35
- package/src/bmm-skills/2-plan-workflows/bmad-edit-prd/workflow.md +0 -62
- package/src/bmm-skills/2-plan-workflows/bmad-validate-prd/workflow.md +0 -61
- package/src/bmm-skills/3-solutioning/bmad-agent-architect/bmad-skill-manifest.yaml +0 -11
- package/src/bmm-skills/3-solutioning/bmad-check-implementation-readiness/workflow.md +0 -47
- package/src/bmm-skills/3-solutioning/bmad-create-architecture/workflow.md +0 -32
- package/src/bmm-skills/3-solutioning/bmad-create-epics-and-stories/workflow.md +0 -51
- package/src/bmm-skills/3-solutioning/bmad-generate-project-context/workflow.md +0 -39
- package/src/bmm-skills/4-implementation/bmad-agent-dev/bmad-skill-manifest.yaml +0 -11
- package/src/bmm-skills/4-implementation/bmad-code-review/workflow.md +0 -55
- package/src/bmm-skills/4-implementation/bmad-correct-course/workflow.md +0 -267
- package/src/bmm-skills/4-implementation/bmad-create-story/workflow.md +0 -380
- package/src/bmm-skills/4-implementation/bmad-dev-story/workflow.md +0 -450
- package/src/bmm-skills/4-implementation/bmad-qa-generate-e2e-tests/workflow.md +0 -136
- package/src/bmm-skills/4-implementation/bmad-quick-dev/workflow.md +0 -76
- package/src/bmm-skills/4-implementation/bmad-retrospective/workflow.md +0 -1479
- package/src/bmm-skills/4-implementation/bmad-sprint-planning/workflow.md +0 -263
- package/src/bmm-skills/4-implementation/bmad-sprint-status/workflow.md +0 -261
|
@@ -3,4 +3,174 @@ name: bmad-qa-generate-e2e-tests
|
|
|
3
3
|
description: 'Generate end to end automated tests for existing features. Use when the user says "create qa automated tests for [feature]"'
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
# QA Generate E2E Tests Workflow
|
|
7
|
+
|
|
8
|
+
**Goal:** Generate automated API and E2E tests for implemented code.
|
|
9
|
+
|
|
10
|
+
**Your Role:** You are a QA automation engineer. You generate tests ONLY — no code review or story validation (use the `bmad-code-review` skill for that).
|
|
11
|
+
|
|
12
|
+
## Conventions
|
|
13
|
+
|
|
14
|
+
- Bare paths (e.g. `checklist.md`) resolve from the skill root.
|
|
15
|
+
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
|
16
|
+
- `{project-root}`-prefixed paths resolve from the project working directory.
|
|
17
|
+
- `{skill-name}` resolves to the skill directory's basename.
|
|
18
|
+
|
|
19
|
+
## On Activation
|
|
20
|
+
|
|
21
|
+
### Step 1: Resolve the Workflow Block
|
|
22
|
+
|
|
23
|
+
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
|
24
|
+
|
|
25
|
+
**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver:
|
|
26
|
+
|
|
27
|
+
1. `{skill-root}/customize.toml` — defaults
|
|
28
|
+
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
|
29
|
+
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
|
30
|
+
|
|
31
|
+
Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append.
|
|
32
|
+
|
|
33
|
+
### Step 2: Execute Prepend Steps
|
|
34
|
+
|
|
35
|
+
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
|
36
|
+
|
|
37
|
+
### Step 3: Load Persistent Facts
|
|
38
|
+
|
|
39
|
+
Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` — load the referenced contents as facts. All other entries are facts verbatim.
|
|
40
|
+
|
|
41
|
+
### Step 4: Load Config
|
|
42
|
+
|
|
43
|
+
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
|
44
|
+
|
|
45
|
+
- `project_name`, `user_name`
|
|
46
|
+
- `communication_language`, `document_output_language`
|
|
47
|
+
- `implementation_artifacts`
|
|
48
|
+
- `date` as system-generated current datetime
|
|
49
|
+
- YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config `{communication_language}`
|
|
50
|
+
|
|
51
|
+
### Step 5: Greet the User
|
|
52
|
+
|
|
53
|
+
Greet `{user_name}`, speaking in `{communication_language}`.
|
|
54
|
+
|
|
55
|
+
### Step 6: Execute Append Steps
|
|
56
|
+
|
|
57
|
+
Execute each entry in `{workflow.activation_steps_append}` in order.
|
|
58
|
+
|
|
59
|
+
Activation is complete. Begin the workflow below.
|
|
60
|
+
|
|
61
|
+
## Paths
|
|
62
|
+
|
|
63
|
+
- `test_dir` = `{project-root}/tests`
|
|
64
|
+
- `source_dir` = `{project-root}`
|
|
65
|
+
- `default_output_file` = `{implementation_artifacts}/tests/test-summary.md`
|
|
66
|
+
|
|
67
|
+
## Execution
|
|
68
|
+
|
|
69
|
+
### Step 0: Detect Test Framework
|
|
70
|
+
|
|
71
|
+
Check project for existing test framework:
|
|
72
|
+
|
|
73
|
+
- Look for `package.json` dependencies (playwright, jest, vitest, cypress, etc.)
|
|
74
|
+
- Check for existing test files to understand patterns
|
|
75
|
+
- Use whatever test framework the project already has
|
|
76
|
+
- If no framework exists:
|
|
77
|
+
- Analyze source code to determine project type (React, Vue, Node API, etc.)
|
|
78
|
+
- Search online for current recommended test framework for that stack
|
|
79
|
+
- Suggest the meta framework and use it (or ask user to confirm)
|
|
80
|
+
|
|
81
|
+
### Step 1: Identify Features
|
|
82
|
+
|
|
83
|
+
Ask user what to test:
|
|
84
|
+
|
|
85
|
+
- Specific feature/component name
|
|
86
|
+
- Directory to scan (e.g., `src/components/`)
|
|
87
|
+
- Or auto-discover features in the codebase
|
|
88
|
+
|
|
89
|
+
### Step 2: Generate API Tests (if applicable)
|
|
90
|
+
|
|
91
|
+
For API endpoints/services, generate tests that:
|
|
92
|
+
|
|
93
|
+
- Test status codes (200, 400, 404, 500)
|
|
94
|
+
- Validate response structure
|
|
95
|
+
- Cover happy path + 1-2 error cases
|
|
96
|
+
- Use project's existing test framework patterns
|
|
97
|
+
|
|
98
|
+
### Step 3: Generate E2E Tests (if UI exists)
|
|
99
|
+
|
|
100
|
+
For UI features, generate tests that:
|
|
101
|
+
|
|
102
|
+
- Test user workflows end-to-end
|
|
103
|
+
- Use semantic locators (roles, labels, text)
|
|
104
|
+
- Focus on user interactions (clicks, form fills, navigation)
|
|
105
|
+
- Assert visible outcomes
|
|
106
|
+
- Keep tests linear and simple
|
|
107
|
+
- Follow project's existing test patterns
|
|
108
|
+
|
|
109
|
+
### Step 4: Run Tests
|
|
110
|
+
|
|
111
|
+
Execute tests to verify they pass (use project's test command).
|
|
112
|
+
|
|
113
|
+
If failures occur, fix them immediately.
|
|
114
|
+
|
|
115
|
+
### Step 5: Create Summary
|
|
116
|
+
|
|
117
|
+
Output markdown summary:
|
|
118
|
+
|
|
119
|
+
```markdown
|
|
120
|
+
# Test Automation Summary
|
|
121
|
+
|
|
122
|
+
## Generated Tests
|
|
123
|
+
|
|
124
|
+
### API Tests
|
|
125
|
+
- [x] tests/api/endpoint.spec.ts - Endpoint validation
|
|
126
|
+
|
|
127
|
+
### E2E Tests
|
|
128
|
+
- [x] tests/e2e/feature.spec.ts - User workflow
|
|
129
|
+
|
|
130
|
+
## Coverage
|
|
131
|
+
- API endpoints: 5/10 covered
|
|
132
|
+
- UI features: 3/8 covered
|
|
133
|
+
|
|
134
|
+
## Next Steps
|
|
135
|
+
- Run tests in CI
|
|
136
|
+
- Add more edge cases as needed
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
## Keep It Simple
|
|
140
|
+
|
|
141
|
+
**Do:**
|
|
142
|
+
|
|
143
|
+
- Use standard test framework APIs
|
|
144
|
+
- Focus on happy path + critical errors
|
|
145
|
+
- Write readable, maintainable tests
|
|
146
|
+
- Run tests to verify they pass
|
|
147
|
+
|
|
148
|
+
**Avoid:**
|
|
149
|
+
|
|
150
|
+
- Complex fixture composition
|
|
151
|
+
- Over-engineering
|
|
152
|
+
- Unnecessary abstractions
|
|
153
|
+
|
|
154
|
+
**For Advanced Features:**
|
|
155
|
+
|
|
156
|
+
If the project needs:
|
|
157
|
+
|
|
158
|
+
- Risk-based test strategy
|
|
159
|
+
- Test design planning
|
|
160
|
+
- Quality gates and NFR assessment
|
|
161
|
+
- Comprehensive coverage analysis
|
|
162
|
+
- Advanced testing patterns and utilities
|
|
163
|
+
|
|
164
|
+
> **Install Test Architect (TEA) module**: <https://bmad-code-org.github.io/bmad-method-test-architecture-enterprise/>
|
|
165
|
+
|
|
166
|
+
## Output
|
|
167
|
+
|
|
168
|
+
Save summary to: `{default_output_file}`
|
|
169
|
+
|
|
170
|
+
**Done!** Tests generated and verified. Validate against `./checklist.md`.
|
|
171
|
+
|
|
172
|
+
## On Complete
|
|
173
|
+
|
|
174
|
+
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
|
175
|
+
|
|
176
|
+
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# DO NOT EDIT -- overwritten on every update.
|
|
2
|
+
#
|
|
3
|
+
# Workflow customization surface for bmad-qa-generate-e2e-tests. Mirrors the
|
|
4
|
+
# agent customization shape under the [workflow] namespace.
|
|
5
|
+
|
|
6
|
+
[workflow]
|
|
7
|
+
|
|
8
|
+
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
|
9
|
+
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
|
10
|
+
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
|
11
|
+
|
|
12
|
+
# Steps to run before the standard activation (config load, greet).
|
|
13
|
+
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
|
14
|
+
|
|
15
|
+
activation_steps_prepend = []
|
|
16
|
+
|
|
17
|
+
# Steps to run after greet but before the workflow begins.
|
|
18
|
+
# Overrides append. Use for context-heavy setup that should happen
|
|
19
|
+
# once the user has been acknowledged.
|
|
20
|
+
|
|
21
|
+
activation_steps_append = []
|
|
22
|
+
|
|
23
|
+
# Persistent facts the workflow keeps in mind for the whole run
|
|
24
|
+
# (standards, compliance constraints, stylistic guardrails).
|
|
25
|
+
# Distinct from the runtime memory sidecar — these are static context
|
|
26
|
+
# loaded on activation. Overrides append.
|
|
27
|
+
#
|
|
28
|
+
# Each entry is either:
|
|
29
|
+
# - a literal sentence, e.g. "All tests must follow the project's existing test framework patterns."
|
|
30
|
+
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
|
31
|
+
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
|
32
|
+
|
|
33
|
+
persistent_facts = [
|
|
34
|
+
"file:{project-root}/**/project-context.md",
|
|
35
|
+
]
|
|
36
|
+
|
|
37
|
+
# Scalar: executed when the workflow reaches Step 5 (Create Summary),
|
|
38
|
+
# after all tests pass and the summary document is saved. Override wins.
|
|
39
|
+
# Leave empty for no custom post-completion behavior.
|
|
40
|
+
|
|
41
|
+
on_complete = ""
|
|
@@ -3,4 +3,109 @@ name: bmad-quick-dev
|
|
|
3
3
|
description: 'Implements any user intent, requirement, story, bug fix or change request by producing clean working code artifacts that follow the project''s existing architecture, patterns and conventions. Use when the user wants to build, fix, tweak, refactor, add or modify any code, component or feature.'
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
# Quick Dev New Preview Workflow
|
|
7
|
+
|
|
8
|
+
**Goal:** Turn user intent into a hardened, reviewable artifact.
|
|
9
|
+
|
|
10
|
+
**CRITICAL:** If a step says "read fully and follow step-XX", you read and follow step-XX. No exceptions.
|
|
11
|
+
|
|
12
|
+
## READY FOR DEVELOPMENT STANDARD
|
|
13
|
+
|
|
14
|
+
A specification is "Ready for Development" when:
|
|
15
|
+
|
|
16
|
+
- **Actionable**: Every task has a file path and specific action.
|
|
17
|
+
- **Logical**: Tasks ordered by dependency.
|
|
18
|
+
- **Testable**: All ACs use Given/When/Then.
|
|
19
|
+
- **Complete**: No placeholders or TBDs.
|
|
20
|
+
|
|
21
|
+
## SCOPE STANDARD
|
|
22
|
+
|
|
23
|
+
A specification should target a **single user-facing goal** within **900–1600 tokens**:
|
|
24
|
+
|
|
25
|
+
- **Single goal**: One cohesive feature, even if it spans multiple layers/files. Multi-goal means >=2 **top-level independent shippable deliverables** — each could be reviewed, tested, and merged as a separate PR without breaking the others. Never count surface verbs, "and" conjunctions, or noun phrases. Never split cross-layer implementation details inside one user goal.
|
|
26
|
+
- Split: "add dark mode toggle AND refactor auth to JWT AND build admin dashboard"
|
|
27
|
+
- Don't split: "add validation and display errors" / "support drag-and-drop AND paste AND retry"
|
|
28
|
+
- **900–1600 tokens**: Optimal range for LLM consumption. Below 900 risks ambiguity; above 1600 risks context-rot in implementation agents.
|
|
29
|
+
- **Neither limit is a gate.** Both are proposals with user override.
|
|
30
|
+
|
|
31
|
+
## Conventions
|
|
32
|
+
|
|
33
|
+
- Bare paths (e.g. `step-01-clarify-and-route.md`) resolve from the skill root.
|
|
34
|
+
- `{skill-root}` resolves to this skill's installed directory (where `customize.toml` lives).
|
|
35
|
+
- `{project-root}`-prefixed paths resolve from the project working directory.
|
|
36
|
+
- `{skill-name}` resolves to the skill directory's basename.
|
|
37
|
+
|
|
38
|
+
## On Activation
|
|
39
|
+
|
|
40
|
+
### Step 1: Resolve the Workflow Block
|
|
41
|
+
|
|
42
|
+
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow`
|
|
43
|
+
|
|
44
|
+
**If the script fails**, resolve the `workflow` block yourself by reading these three files in base → team → user order and applying the same structural merge rules as the resolver:
|
|
45
|
+
|
|
46
|
+
1. `{skill-root}/customize.toml` — defaults
|
|
47
|
+
2. `{project-root}/_bmad/custom/{skill-name}.toml` — team overrides
|
|
48
|
+
3. `{project-root}/_bmad/custom/{skill-name}.user.toml` — personal overrides
|
|
49
|
+
|
|
50
|
+
Any missing file is skipped. Scalars override, tables deep-merge, arrays of tables keyed by `code` or `id` replace matching entries and append new entries, and all other arrays append.
|
|
51
|
+
|
|
52
|
+
### Step 2: Execute Prepend Steps
|
|
53
|
+
|
|
54
|
+
Execute each entry in `{workflow.activation_steps_prepend}` in order before proceeding.
|
|
55
|
+
|
|
56
|
+
### Step 3: Load Persistent Facts
|
|
57
|
+
|
|
58
|
+
Treat every entry in `{workflow.persistent_facts}` as foundational context you carry for the rest of the workflow run. Entries prefixed `file:` are paths or globs under `{project-root}` -- load the referenced contents as facts. All other entries are facts verbatim.
|
|
59
|
+
|
|
60
|
+
### Step 4: Load Config
|
|
61
|
+
|
|
62
|
+
Load config from `{project-root}/_bmad/bmm/config.yaml` and resolve:
|
|
63
|
+
|
|
64
|
+
- `project_name`, `planning_artifacts`, `implementation_artifacts`, `user_name`
|
|
65
|
+
- `communication_language`, `document_output_language`, `user_skill_level`
|
|
66
|
+
- `date` as system-generated current datetime
|
|
67
|
+
- `sprint_status` = `{implementation_artifacts}/sprint-status.yaml`
|
|
68
|
+
- `project_context` = `**/project-context.md` (load if exists)
|
|
69
|
+
- CLAUDE.md / memory files (load if exist)
|
|
70
|
+
- YOU MUST ALWAYS SPEAK OUTPUT in your Agent communication style with the config `{communication_language}`
|
|
71
|
+
- Language MUST be tailored to `{user_skill_level}`
|
|
72
|
+
- Generate all documents in `{document_output_language}`
|
|
73
|
+
|
|
74
|
+
### Step 5: Greet the User
|
|
75
|
+
|
|
76
|
+
Greet `{user_name}`, speaking in `{communication_language}`.
|
|
77
|
+
|
|
78
|
+
### Step 6: Execute Append Steps
|
|
79
|
+
|
|
80
|
+
Execute each entry in `{workflow.activation_steps_append}` in order.
|
|
81
|
+
|
|
82
|
+
Activation is complete. Begin the workflow below.
|
|
83
|
+
|
|
84
|
+
## WORKFLOW ARCHITECTURE
|
|
85
|
+
|
|
86
|
+
This uses **step-file architecture** for disciplined execution:
|
|
87
|
+
|
|
88
|
+
- **Micro-file Design**: Each step is self-contained and followed exactly
|
|
89
|
+
- **Just-In-Time Loading**: Only load the current step file
|
|
90
|
+
- **Sequential Enforcement**: Complete steps in order, no skipping
|
|
91
|
+
- **State Tracking**: Persist progress via spec frontmatter and in-memory variables
|
|
92
|
+
- **Append-Only Building**: Build artifacts incrementally
|
|
93
|
+
|
|
94
|
+
### Step Processing Rules
|
|
95
|
+
|
|
96
|
+
1. **READ COMPLETELY**: Read the entire step file before acting
|
|
97
|
+
2. **FOLLOW SEQUENCE**: Execute sections in order
|
|
98
|
+
3. **WAIT FOR INPUT**: Halt at checkpoints and wait for human
|
|
99
|
+
4. **LOAD NEXT**: When directed, read fully and follow the next step file
|
|
100
|
+
|
|
101
|
+
### Critical Rules (NO EXCEPTIONS)
|
|
102
|
+
|
|
103
|
+
- **NEVER** load multiple step files simultaneously
|
|
104
|
+
- **ALWAYS** read entire step file before execution
|
|
105
|
+
- **NEVER** skip steps or optimize the sequence
|
|
106
|
+
- **ALWAYS** follow the exact instructions in the step file
|
|
107
|
+
- **ALWAYS** halt at checkpoints and wait for human input
|
|
108
|
+
|
|
109
|
+
## FIRST STEP
|
|
110
|
+
|
|
111
|
+
Read fully and follow: `./step-01-clarify-and-route.md` to begin the workflow.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# DO NOT EDIT -- overwritten on every update.
|
|
2
|
+
#
|
|
3
|
+
# Workflow customization surface for bmad-quick-dev. Mirrors the
|
|
4
|
+
# agent customization shape under the [workflow] namespace.
|
|
5
|
+
|
|
6
|
+
[workflow]
|
|
7
|
+
|
|
8
|
+
# --- Configurable below. Overrides merge per BMad structural rules: ---
|
|
9
|
+
# scalars: override wins • arrays (persistent_facts, activation_steps_*): append
|
|
10
|
+
# arrays-of-tables with `code`/`id`: replace matching items, append new ones.
|
|
11
|
+
|
|
12
|
+
# Steps to run before the standard activation (config load, greet).
|
|
13
|
+
# Overrides append. Use for pre-flight loads, compliance checks, etc.
|
|
14
|
+
|
|
15
|
+
activation_steps_prepend = []
|
|
16
|
+
|
|
17
|
+
# Steps to run after greet but before the workflow begins.
|
|
18
|
+
# Overrides append. Use for context-heavy setup that should happen
|
|
19
|
+
# once the user has been acknowledged.
|
|
20
|
+
|
|
21
|
+
activation_steps_append = []
|
|
22
|
+
|
|
23
|
+
# Persistent facts the workflow keeps in mind for the whole run
|
|
24
|
+
# (standards, compliance constraints, stylistic guardrails).
|
|
25
|
+
# Distinct from the runtime memory sidecar — these are static context
|
|
26
|
+
# loaded on activation. Overrides append.
|
|
27
|
+
#
|
|
28
|
+
# Each entry is either:
|
|
29
|
+
# - a literal sentence, e.g. "All stories must include testable acceptance criteria."
|
|
30
|
+
# - a file reference prefixed with `file:`, e.g. "file:{project-root}/docs/standards.md"
|
|
31
|
+
# (glob patterns are supported; the file's contents are loaded and treated as facts).
|
|
32
|
+
|
|
33
|
+
persistent_facts = [
|
|
34
|
+
"file:{project-root}/**/project-context.md",
|
|
35
|
+
]
|
|
36
|
+
|
|
37
|
+
# Scalar: executed when the workflow reaches its final step,
|
|
38
|
+
# after implementation is complete and explanations are provided. Override wins.
|
|
39
|
+
# Leave empty for no custom post-completion behavior.
|
|
40
|
+
|
|
41
|
+
on_complete = ""
|
|
@@ -70,3 +70,9 @@ Display summary of your work to the user, including the commit hash if one was c
|
|
|
70
70
|
- Offer to push and/or create a pull request.
|
|
71
71
|
|
|
72
72
|
Workflow complete.
|
|
73
|
+
|
|
74
|
+
## On Complete
|
|
75
|
+
|
|
76
|
+
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
|
77
|
+
|
|
78
|
+
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|
|
@@ -63,3 +63,9 @@ If version control is available and the tree is dirty, create a local commit wit
|
|
|
63
63
|
HALT and wait for human input.
|
|
64
64
|
|
|
65
65
|
Workflow complete.
|
|
66
|
+
|
|
67
|
+
## On Complete
|
|
68
|
+
|
|
69
|
+
Run: `python3 {project-root}/_bmad/scripts/resolve_customization.py --skill {skill-root} --key workflow.on_complete`
|
|
70
|
+
|
|
71
|
+
If the resolved `workflow.on_complete` is non-empty, follow it as the final terminal instruction before exiting.
|