bmalph 1.0.0 → 2.2.1
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/LICENSE +21 -0
- package/README.md +398 -217
- package/bmad/bmm/agents/analyst.agent.yaml +43 -36
- package/bmad/bmm/agents/architect.agent.yaml +29 -28
- package/bmad/bmm/agents/dev.agent.yaml +38 -38
- package/bmad/bmm/agents/pm.agent.yaml +44 -46
- package/bmad/bmm/agents/qa.agent.yaml +58 -0
- package/bmad/bmm/agents/quick-flow-solo-dev.agent.yaml +32 -32
- package/bmad/bmm/agents/sm.agent.yaml +37 -36
- package/bmad/bmm/agents/tech-writer/tech-writer-sidecar/documentation-standards.md +223 -223
- package/bmad/bmm/agents/tech-writer/tech-writer.agent.yaml +46 -45
- package/bmad/bmm/agents/ux-designer.agent.yaml +27 -26
- package/bmad/bmm/data/project-context-template.md +26 -26
- package/bmad/bmm/module-help.csv +31 -31
- package/bmad/bmm/module.yaml +50 -44
- package/bmad/bmm/teams/default-party.csv +20 -21
- package/bmad/bmm/teams/team-fullstack.yaml +12 -12
- package/bmad/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -10
- package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +177 -177
- package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +161 -161
- package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +199 -199
- package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +202 -202
- package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +205 -205
- package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +219 -219
- package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +162 -162
- package/bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md +57 -58
- package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -137
- package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -229
- package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -238
- package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -206
- package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -234
- package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +443 -443
- package/bmad/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -182
- package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -237
- package/bmad/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -249
- package/bmad/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -259
- package/bmad/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -177
- package/bmad/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +475 -475
- package/bmad/bmm/workflows/1-analysis/research/research.template.md +29 -29
- package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -137
- package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -239
- package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -248
- package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -202
- package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +233 -239
- package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +486 -486
- package/bmad/bmm/workflows/1-analysis/research/workflow-domain-research.md +54 -0
- package/bmad/bmm/workflows/1-analysis/research/workflow-market-research.md +54 -0
- package/bmad/bmm/workflows/1-analysis/research/workflow-technical-research.md +54 -0
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/data/domain-complexity.csv +14 -12
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/data/prd-purpose.md +197 -197
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/data/project-types.csv +10 -10
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-01-init.md +191 -191
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-01b-continue.md +153 -153
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-02-discovery.md +224 -224
- package/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02b-vision.md +154 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02c-executive-summary.md +170 -0
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-03-success.md +226 -226
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-04-journeys.md +213 -213
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-05-domain.md +207 -207
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-06-innovation.md +226 -226
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-07-project-type.md +237 -237
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-08-scoping.md +228 -228
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-09-functional.md +231 -231
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-10-nonfunctional.md +242 -242
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-11-polish.md +217 -217
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-c/step-12-complete.md +124 -124
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-01-discovery.md +247 -247
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-01b-legacy-conversion.md +208 -208
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-02-review.md +249 -249
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-03-edit.md +253 -253
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-e/step-e-04-complete.md +168 -168
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-01-discovery.md +226 -218
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-02-format-detection.md +191 -191
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-02b-parity-check.md +209 -209
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-03-density-validation.md +174 -174
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-04-brief-coverage-validation.md +214 -214
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-05-measurability-validation.md +228 -228
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-06-traceability-validation.md +217 -217
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-07-implementation-leakage-validation.md +205 -205
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-08-domain-compliance-validation.md +243 -243
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-09-project-type-validation.md +263 -263
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-10-smart-validation.md +209 -209
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-11-holistic-quality-validation.md +264 -264
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-12-completeness-validation.md +242 -242
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/steps-v/step-v-13-report-complete.md +231 -231
- package/bmad/bmm/workflows/2-plan-workflows/{prd → create-prd}/templates/prd-template.md +10 -10
- package/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md +63 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md +65 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md +63 -0
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -135
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -127
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -190
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -216
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -219
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -234
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -252
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -254
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -224
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -224
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -241
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +248 -248
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -237
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -264
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +171 -171
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -13
- package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +42 -43
- package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +184 -190
- package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +172 -178
- package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +173 -179
- package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +133 -139
- package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +245 -252
- package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +129 -135
- package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -4
- package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +54 -55
- package/bmad/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -12
- package/bmad/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +12 -10
- package/bmad/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +6 -6
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +153 -153
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +164 -164
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -224
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +331 -331
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +318 -318
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +359 -359
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -379
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +359 -359
- package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +76 -76
- package/bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md +49 -50
- package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -259
- package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -233
- package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -272
- package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +149 -149
- package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -57
- package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +58 -59
- package/bmad/bmm/workflows/4-implementation/code-review/checklist.md +23 -23
- package/bmad/bmm/workflows/4-implementation/code-review/instructions.xml +226 -226
- package/bmad/bmm/workflows/4-implementation/code-review/workflow.yaml +44 -51
- package/bmad/bmm/workflows/4-implementation/correct-course/checklist.md +288 -288
- package/bmad/bmm/workflows/4-implementation/correct-course/instructions.md +207 -206
- package/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml +54 -60
- package/bmad/bmm/workflows/4-implementation/create-story/checklist.md +358 -358
- package/bmad/bmm/workflows/4-implementation/create-story/instructions.xml +346 -345
- package/bmad/bmm/workflows/4-implementation/create-story/template.md +49 -49
- package/bmad/bmm/workflows/4-implementation/create-story/workflow.yaml +53 -61
- package/bmad/bmm/workflows/4-implementation/dev-story/checklist.md +80 -80
- package/bmad/bmm/workflows/4-implementation/dev-story/instructions.xml +410 -410
- package/bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml +21 -27
- package/bmad/bmm/workflows/4-implementation/retrospective/instructions.md +1444 -1443
- package/bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml +53 -58
- package/bmad/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -33
- package/bmad/bmm/workflows/4-implementation/sprint-planning/instructions.md +226 -225
- package/bmad/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -55
- package/bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +47 -54
- package/bmad/bmm/workflows/4-implementation/sprint-status/instructions.md +230 -229
- package/bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml +25 -36
- package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +174 -156
- package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +118 -120
- package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +111 -113
- package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +111 -113
- package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +104 -106
- package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +146 -140
- package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +50 -50
- package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-01-understand.md +191 -189
- package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +144 -144
- package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +127 -128
- package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +200 -191
- package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/tech-spec-template.md +74 -74
- package/bmad/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +79 -79
- package/bmad/bmm/workflows/document-project/checklist.md +245 -245
- package/bmad/bmm/workflows/document-project/documentation-requirements.csv +12 -12
- package/bmad/bmm/workflows/document-project/instructions.md +130 -221
- package/bmad/bmm/workflows/document-project/templates/deep-dive-template.md +345 -345
- package/bmad/bmm/workflows/document-project/templates/index-template.md +169 -169
- package/bmad/bmm/workflows/document-project/templates/project-overview-template.md +103 -103
- package/bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -160
- package/bmad/bmm/workflows/document-project/templates/source-tree-template.md +135 -135
- package/bmad/bmm/workflows/document-project/workflow.yaml +22 -30
- package/bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -298
- package/bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -31
- package/bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -1106
- package/bmad/bmm/workflows/document-project/workflows/full-scan.yaml +31 -31
- package/bmad/bmm/workflows/generate-project-context/project-context-template.md +21 -0
- package/bmad/bmm/workflows/generate-project-context/steps/step-01-discover.md +184 -0
- package/bmad/bmm/workflows/generate-project-context/steps/step-02-generate.md +318 -0
- package/bmad/bmm/workflows/generate-project-context/steps/step-03-complete.md +278 -0
- package/bmad/bmm/workflows/generate-project-context/workflow.md +49 -0
- package/bmad/bmm/workflows/qa/automate/checklist.md +33 -0
- package/bmad/bmm/workflows/qa/automate/instructions.md +110 -0
- package/bmad/bmm/workflows/qa/automate/workflow.yaml +44 -0
- package/bmad/core/agents/bmad-master.agent.yaml +30 -30
- package/bmad/core/module-help.csv +9 -11
- package/bmad/core/module.yaml +25 -25
- package/bmad/core/tasks/editorial-review-prose.xml +102 -91
- package/bmad/core/tasks/editorial-review-structure.xml +209 -198
- package/bmad/core/tasks/help.md +85 -0
- package/bmad/core/tasks/index-docs.xml +64 -64
- package/bmad/core/tasks/review-adversarial-general.xml +48 -48
- package/bmad/core/tasks/shard-doc.xml +107 -108
- package/bmad/core/tasks/workflow.xml +234 -234
- package/bmad/core/workflows/advanced-elicitation/methods.csv +51 -51
- package/bmad/core/workflows/advanced-elicitation/workflow.xml +116 -116
- package/bmad/core/workflows/brainstorming/brain-methods.csv +61 -61
- package/bmad/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -197
- package/bmad/core/workflows/brainstorming/steps/step-01b-continue.md +122 -122
- package/bmad/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -225
- package/bmad/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -237
- package/bmad/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -209
- package/bmad/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -264
- package/bmad/core/workflows/brainstorming/steps/step-03-technique-execution.md +399 -399
- package/bmad/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -303
- package/bmad/core/workflows/brainstorming/template.md +15 -15
- package/bmad/core/workflows/brainstorming/workflow.md +58 -58
- package/bmad/core/workflows/party-mode/steps/step-01-agent-loading.md +138 -138
- package/bmad/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +187 -187
- package/bmad/core/workflows/party-mode/steps/step-03-graceful-exit.md +168 -157
- package/bmad/core/workflows/party-mode/workflow.md +194 -194
- package/bundled-versions.json +3 -0
- package/dist/cli.js +61 -6
- package/dist/commands/check-updates.d.ts +5 -0
- package/dist/commands/check-updates.js +63 -0
- package/dist/commands/doctor.d.ts +39 -1
- package/dist/commands/doctor.js +348 -79
- package/dist/commands/init.d.ts +2 -0
- package/dist/commands/init.js +41 -15
- package/dist/commands/status.d.ts +7 -1
- package/dist/commands/status.js +111 -42
- package/dist/commands/upgrade.d.ts +7 -1
- package/dist/commands/upgrade.js +43 -12
- package/dist/installer.d.ts +19 -2
- package/dist/installer.js +305 -66
- package/dist/transition/artifacts.d.ts +2 -0
- package/dist/transition/artifacts.js +46 -0
- package/dist/transition/context.d.ts +19 -0
- package/dist/transition/context.js +261 -0
- package/dist/transition/fix-plan.d.ts +15 -0
- package/dist/transition/fix-plan.js +94 -0
- package/dist/transition/index.d.ts +9 -0
- package/dist/transition/index.js +16 -0
- package/dist/transition/orchestration.d.ts +2 -0
- package/dist/transition/orchestration.js +243 -0
- package/dist/transition/specs-changelog.d.ts +3 -0
- package/dist/transition/specs-changelog.js +75 -0
- package/dist/transition/specs-index.d.ts +22 -0
- package/dist/transition/specs-index.js +157 -0
- package/dist/transition/story-parsing.d.ts +7 -0
- package/dist/transition/story-parsing.js +124 -0
- package/dist/transition/tech-stack.d.ts +3 -0
- package/dist/transition/tech-stack.js +79 -0
- package/dist/transition/types.d.ts +60 -0
- package/dist/transition/types.js +1 -0
- package/dist/utils/config.d.ts +4 -0
- package/dist/utils/config.js +14 -4
- package/dist/utils/constants.d.ts +70 -0
- package/dist/utils/constants.js +97 -0
- package/dist/utils/dryrun.d.ts +7 -0
- package/dist/utils/dryrun.js +48 -0
- package/dist/utils/errors.d.ts +63 -0
- package/dist/utils/errors.js +86 -0
- package/dist/utils/file-system.d.ts +24 -0
- package/dist/utils/file-system.js +99 -0
- package/dist/utils/github.d.ts +83 -0
- package/dist/utils/github.js +230 -0
- package/dist/utils/json.js +3 -3
- package/dist/utils/logger.d.ts +6 -0
- package/dist/utils/logger.js +27 -0
- package/dist/utils/state.d.ts +4 -7
- package/dist/utils/state.js +147 -26
- package/dist/utils/validate.d.ts +40 -0
- package/dist/utils/validate.js +175 -1
- package/package.json +75 -59
- package/ralph/RALPH-REFERENCE.md +412 -0
- package/ralph/lib/circuit_breaker.sh +463 -330
- package/ralph/lib/date_utils.sh +104 -53
- package/ralph/lib/enable_core.sh +815 -0
- package/ralph/lib/response_analyzer.sh +884 -768
- package/ralph/lib/task_sources.sh +577 -0
- package/ralph/lib/timeout_utils.sh +145 -145
- package/ralph/lib/wizard_utils.sh +547 -0
- package/ralph/ralph_import.sh +636 -0
- package/ralph/ralph_loop.sh +1793 -1391
- package/ralph/ralph_monitor.sh +125 -0
- package/ralph/templates/AGENT.md +158 -158
- package/ralph/templates/PROMPT.md +285 -292
- package/ralph/templates/fix_plan.md +27 -27
- package/ralph/templates/ralphrc.template +102 -0
- package/ralph/templates/specs/.gitkeep +1 -1
- package/slash-commands/advanced-elicitation.md +1 -1
- package/slash-commands/adversarial-review.md +1 -1
- package/slash-commands/analyst.md +1 -1
- package/slash-commands/architect.md +1 -1
- package/slash-commands/bmad-help.md +1 -1
- package/slash-commands/bmalph-implement.md +152 -152
- package/slash-commands/brainstorm-project.md +1 -1
- package/slash-commands/brainstorming.md +1 -1
- package/slash-commands/correct-course.md +1 -1
- package/slash-commands/create-architecture.md +1 -1
- package/slash-commands/create-brief.md +1 -1
- package/slash-commands/create-epics-stories.md +1 -1
- package/slash-commands/create-prd.md +1 -1
- package/slash-commands/create-story.md +1 -1
- package/slash-commands/create-ux.md +1 -1
- package/slash-commands/dev.md +1 -1
- package/slash-commands/document-project.md +1 -1
- package/slash-commands/domain-research.md +1 -1
- package/slash-commands/editorial-prose.md +1 -1
- package/slash-commands/editorial-structure.md +1 -1
- package/slash-commands/execute-workflow.md +1 -1
- package/slash-commands/generate-project-context.md +1 -0
- package/slash-commands/implementation-readiness.md +1 -1
- package/slash-commands/index-docs.md +1 -1
- package/slash-commands/market-research.md +1 -1
- package/slash-commands/party-mode.md +1 -1
- package/slash-commands/pm.md +1 -1
- package/slash-commands/qa-automate.md +1 -0
- package/slash-commands/qa.md +1 -0
- package/slash-commands/quick-dev.md +1 -1
- package/slash-commands/quick-flow-solo-dev.md +1 -1
- package/slash-commands/retrospective.md +1 -1
- package/slash-commands/shard-doc.md +1 -1
- package/slash-commands/sm.md +1 -1
- package/slash-commands/sprint-planning.md +1 -1
- package/slash-commands/sprint-status.md +1 -1
- package/slash-commands/tech-spec.md +1 -1
- package/slash-commands/tech-writer.md +1 -0
- package/slash-commands/technical-research.md +1 -1
- package/slash-commands/ux-designer.md +1 -1
- package/slash-commands/validate-architecture.md +1 -1
- package/slash-commands/validate-brief.md +1 -1
- package/slash-commands/validate-epics-stories.md +1 -1
- package/slash-commands/validate-prd.md +1 -1
- package/slash-commands/validate-story.md +1 -1
- package/slash-commands/validate-ux.md +1 -1
- package/bmad/bmm/agents/tea.agent.yaml +0 -63
- package/bmad/bmm/sub-modules/claude-code/config.yaml +0 -4
- package/bmad/bmm/sub-modules/claude-code/injections.yaml +0 -242
- package/bmad/bmm/sub-modules/claude-code/readme.md +0 -87
- package/bmad/bmm/testarch/knowledge/adr-quality-readiness-checklist.md +0 -350
- package/bmad/bmm/testarch/knowledge/api-request.md +0 -442
- package/bmad/bmm/testarch/knowledge/api-testing-patterns.md +0 -843
- package/bmad/bmm/testarch/knowledge/auth-session.md +0 -552
- package/bmad/bmm/testarch/knowledge/burn-in.md +0 -273
- package/bmad/bmm/testarch/knowledge/ci-burn-in.md +0 -675
- package/bmad/bmm/testarch/knowledge/component-tdd.md +0 -486
- package/bmad/bmm/testarch/knowledge/contract-testing.md +0 -957
- package/bmad/bmm/testarch/knowledge/data-factories.md +0 -500
- package/bmad/bmm/testarch/knowledge/email-auth.md +0 -721
- package/bmad/bmm/testarch/knowledge/error-handling.md +0 -725
- package/bmad/bmm/testarch/knowledge/feature-flags.md +0 -750
- package/bmad/bmm/testarch/knowledge/file-utils.md +0 -463
- package/bmad/bmm/testarch/knowledge/fixture-architecture.md +0 -401
- package/bmad/bmm/testarch/knowledge/fixtures-composition.md +0 -382
- package/bmad/bmm/testarch/knowledge/intercept-network-call.md +0 -430
- package/bmad/bmm/testarch/knowledge/log.md +0 -429
- package/bmad/bmm/testarch/knowledge/network-error-monitor.md +0 -405
- package/bmad/bmm/testarch/knowledge/network-first.md +0 -486
- package/bmad/bmm/testarch/knowledge/network-recorder.md +0 -527
- package/bmad/bmm/testarch/knowledge/nfr-criteria.md +0 -670
- package/bmad/bmm/testarch/knowledge/overview.md +0 -286
- package/bmad/bmm/testarch/knowledge/playwright-config.md +0 -730
- package/bmad/bmm/testarch/knowledge/probability-impact.md +0 -601
- package/bmad/bmm/testarch/knowledge/recurse.md +0 -421
- package/bmad/bmm/testarch/knowledge/risk-governance.md +0 -615
- package/bmad/bmm/testarch/knowledge/selective-testing.md +0 -732
- package/bmad/bmm/testarch/knowledge/selector-resilience.md +0 -527
- package/bmad/bmm/testarch/knowledge/test-healing-patterns.md +0 -644
- package/bmad/bmm/testarch/knowledge/test-levels-framework.md +0 -473
- package/bmad/bmm/testarch/knowledge/test-priorities-matrix.md +0 -373
- package/bmad/bmm/testarch/knowledge/test-quality.md +0 -664
- package/bmad/bmm/testarch/knowledge/timing-debugging.md +0 -372
- package/bmad/bmm/testarch/knowledge/visual-debugging.md +0 -524
- package/bmad/bmm/testarch/tea-index.csv +0 -35
- package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +0 -200
- package/bmad/bmm/workflows/1-analysis/research/workflow.md +0 -173
- package/bmad/bmm/workflows/2-plan-workflows/prd/validation-report-prd-workflow.md +0 -433
- package/bmad/bmm/workflows/2-plan-workflows/prd/workflow.md +0 -150
- package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/data/project-levels.yaml +0 -59
- package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json +0 -90
- package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml +0 -127
- package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md +0 -39
- package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +0 -130
- package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml +0 -27
- package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md +0 -43
- package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +0 -141
- package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml +0 -27
- package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md +0 -49
- package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +0 -241
- package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml +0 -27
- package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md +0 -38
- package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +0 -133
- package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml +0 -27
- package/bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +0 -363
- package/bmad/bmm/workflows/testarch/atdd/checklist.md +0 -374
- package/bmad/bmm/workflows/testarch/atdd/instructions.md +0 -806
- package/bmad/bmm/workflows/testarch/atdd/workflow.yaml +0 -47
- package/bmad/bmm/workflows/testarch/automate/checklist.md +0 -582
- package/bmad/bmm/workflows/testarch/automate/instructions.md +0 -1324
- package/bmad/bmm/workflows/testarch/automate/workflow.yaml +0 -54
- package/bmad/bmm/workflows/testarch/ci/checklist.md +0 -247
- package/bmad/bmm/workflows/testarch/ci/github-actions-template.yaml +0 -198
- package/bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +0 -149
- package/bmad/bmm/workflows/testarch/ci/instructions.md +0 -536
- package/bmad/bmm/workflows/testarch/ci/workflow.yaml +0 -47
- package/bmad/bmm/workflows/testarch/framework/checklist.md +0 -320
- package/bmad/bmm/workflows/testarch/framework/instructions.md +0 -481
- package/bmad/bmm/workflows/testarch/framework/workflow.yaml +0 -49
- package/bmad/bmm/workflows/testarch/nfr-assess/checklist.md +0 -407
- package/bmad/bmm/workflows/testarch/nfr-assess/instructions.md +0 -726
- package/bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +0 -461
- package/bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml +0 -49
- package/bmad/bmm/workflows/testarch/test-design/checklist.md +0 -407
- package/bmad/bmm/workflows/testarch/test-design/instructions.md +0 -1158
- package/bmad/bmm/workflows/testarch/test-design/test-design-architecture-template.md +0 -213
- package/bmad/bmm/workflows/testarch/test-design/test-design-qa-template.md +0 -286
- package/bmad/bmm/workflows/testarch/test-design/test-design-template.md +0 -294
- package/bmad/bmm/workflows/testarch/test-design/workflow.yaml +0 -71
- package/bmad/bmm/workflows/testarch/test-review/checklist.md +0 -472
- package/bmad/bmm/workflows/testarch/test-review/instructions.md +0 -628
- package/bmad/bmm/workflows/testarch/test-review/test-review-template.md +0 -390
- package/bmad/bmm/workflows/testarch/test-review/workflow.yaml +0 -48
- package/bmad/bmm/workflows/testarch/trace/checklist.md +0 -642
- package/bmad/bmm/workflows/testarch/trace/instructions.md +0 -1030
- package/bmad/bmm/workflows/testarch/trace/trace-template.md +0 -675
- package/bmad/bmm/workflows/testarch/trace/workflow.yaml +0 -57
- package/bmad/core/resources/excalidraw/README.md +0 -160
- package/bmad/core/resources/excalidraw/excalidraw-helpers.md +0 -127
- package/bmad/core/resources/excalidraw/library-loader.md +0 -50
- package/bmad/core/resources/excalidraw/validate-json-instructions.md +0 -79
- package/bmad/core/tasks/bmad-help.md +0 -62
- package/dist/commands/guide.d.ts +0 -1
- package/dist/commands/guide.js +0 -19
- package/dist/commands/implement.d.ts +0 -1
- package/dist/commands/implement.js +0 -83
- package/dist/commands/plan.d.ts +0 -5
- package/dist/commands/plan.js +0 -44
- package/dist/commands/reset.d.ts +0 -5
- package/dist/commands/reset.js +0 -35
- package/dist/commands/resume.d.ts +0 -1
- package/dist/commands/resume.js +0 -44
- package/dist/commands/start.d.ts +0 -5
- package/dist/commands/start.js +0 -54
- package/dist/transition.d.ts +0 -52
- package/dist/transition.js +0 -656
- package/slash-commands/atdd.md +0 -1
- package/slash-commands/continuous-integration.md +0 -1
- package/slash-commands/create-dataflow.md +0 -1
- package/slash-commands/create-diagram.md +0 -1
- package/slash-commands/create-flowchart.md +0 -1
- package/slash-commands/create-wireframe.md +0 -1
- package/slash-commands/nfr-assess.md +0 -1
- package/slash-commands/tea.md +0 -1
- package/slash-commands/test-automate.md +0 -1
- package/slash-commands/test-design.md +0 -1
- package/slash-commands/test-framework.md +0 -1
- package/slash-commands/test-review.md +0 -1
- package/slash-commands/test-trace.md +0 -1
- package/slash-commands/validate-test-design.md +0 -1
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
#!/bin/bash
|
|
2
|
+
|
|
3
|
+
# Ralph Status Monitor - Live terminal dashboard for the Ralph loop
|
|
4
|
+
set -e
|
|
5
|
+
|
|
6
|
+
STATUS_FILE=".ralph/status.json"
|
|
7
|
+
LOG_FILE=".ralph/logs/ralph.log"
|
|
8
|
+
REFRESH_INTERVAL=2
|
|
9
|
+
|
|
10
|
+
# Colors
|
|
11
|
+
RED='\033[0;31m'
|
|
12
|
+
GREEN='\033[0;32m'
|
|
13
|
+
YELLOW='\033[1;33m'
|
|
14
|
+
BLUE='\033[0;34m'
|
|
15
|
+
PURPLE='\033[0;35m'
|
|
16
|
+
CYAN='\033[0;36m'
|
|
17
|
+
WHITE='\033[1;37m'
|
|
18
|
+
NC='\033[0m'
|
|
19
|
+
|
|
20
|
+
# Clear screen and hide cursor
|
|
21
|
+
clear_screen() {
|
|
22
|
+
clear
|
|
23
|
+
printf '\033[?25l' # Hide cursor
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
# Show cursor on exit
|
|
27
|
+
show_cursor() {
|
|
28
|
+
printf '\033[?25h' # Show cursor
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
# Cleanup function
|
|
32
|
+
cleanup() {
|
|
33
|
+
show_cursor
|
|
34
|
+
echo
|
|
35
|
+
echo "Monitor stopped."
|
|
36
|
+
exit 0
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
# Set up signal handlers
|
|
40
|
+
trap cleanup SIGINT SIGTERM EXIT
|
|
41
|
+
|
|
42
|
+
# Main display function
|
|
43
|
+
display_status() {
|
|
44
|
+
clear_screen
|
|
45
|
+
|
|
46
|
+
# Header
|
|
47
|
+
echo -e "${WHITE}╔════════════════════════════════════════════════════════════════════════╗${NC}"
|
|
48
|
+
echo -e "${WHITE}║ 🤖 RALPH MONITOR ║${NC}"
|
|
49
|
+
echo -e "${WHITE}║ Live Status Dashboard ║${NC}"
|
|
50
|
+
echo -e "${WHITE}╚════════════════════════════════════════════════════════════════════════╝${NC}"
|
|
51
|
+
echo
|
|
52
|
+
|
|
53
|
+
# Status section
|
|
54
|
+
if [[ -f "$STATUS_FILE" ]]; then
|
|
55
|
+
# Parse JSON status
|
|
56
|
+
local status_data=$(cat "$STATUS_FILE")
|
|
57
|
+
local loop_count=$(echo "$status_data" | jq -r '.loop_count // "0"' 2>/dev/null || echo "0")
|
|
58
|
+
local calls_made=$(echo "$status_data" | jq -r '.calls_made_this_hour // "0"' 2>/dev/null || echo "0")
|
|
59
|
+
local max_calls=$(echo "$status_data" | jq -r '.max_calls_per_hour // "100"' 2>/dev/null || echo "100")
|
|
60
|
+
local status=$(echo "$status_data" | jq -r '.status // "unknown"' 2>/dev/null || echo "unknown")
|
|
61
|
+
|
|
62
|
+
echo -e "${CYAN}┌─ Current Status ────────────────────────────────────────────────────────┐${NC}"
|
|
63
|
+
echo -e "${CYAN}│${NC} Loop Count: ${WHITE}#$loop_count${NC}"
|
|
64
|
+
echo -e "${CYAN}│${NC} Status: ${GREEN}$status${NC}"
|
|
65
|
+
echo -e "${CYAN}│${NC} API Calls: $calls_made/$max_calls"
|
|
66
|
+
echo -e "${CYAN}└─────────────────────────────────────────────────────────────────────────┘${NC}"
|
|
67
|
+
echo
|
|
68
|
+
|
|
69
|
+
else
|
|
70
|
+
echo -e "${RED}┌─ Status ────────────────────────────────────────────────────────────────┐${NC}"
|
|
71
|
+
echo -e "${RED}│${NC} Status file not found. Ralph may not be running."
|
|
72
|
+
echo -e "${RED}└─────────────────────────────────────────────────────────────────────────┘${NC}"
|
|
73
|
+
echo
|
|
74
|
+
fi
|
|
75
|
+
|
|
76
|
+
# Claude Code Progress section
|
|
77
|
+
if [[ -f ".ralph/progress.json" ]]; then
|
|
78
|
+
local progress_data=$(cat ".ralph/progress.json" 2>/dev/null)
|
|
79
|
+
local progress_status=$(echo "$progress_data" | jq -r '.status // "idle"' 2>/dev/null || echo "idle")
|
|
80
|
+
|
|
81
|
+
if [[ "$progress_status" == "executing" ]]; then
|
|
82
|
+
local indicator=$(echo "$progress_data" | jq -r '.indicator // "⠋"' 2>/dev/null || echo "⠋")
|
|
83
|
+
local elapsed=$(echo "$progress_data" | jq -r '.elapsed_seconds // "0"' 2>/dev/null || echo "0")
|
|
84
|
+
local last_output=$(echo "$progress_data" | jq -r '.last_output // ""' 2>/dev/null || echo "")
|
|
85
|
+
|
|
86
|
+
echo -e "${YELLOW}┌─ Claude Code Progress ──────────────────────────────────────────────────┐${NC}"
|
|
87
|
+
echo -e "${YELLOW}│${NC} Status: ${indicator} Working (${elapsed}s elapsed)"
|
|
88
|
+
if [[ -n "$last_output" && "$last_output" != "" ]]; then
|
|
89
|
+
# Truncate long output for display
|
|
90
|
+
local display_output=$(echo "$last_output" | head -c 60)
|
|
91
|
+
echo -e "${YELLOW}│${NC} Output: ${display_output}..."
|
|
92
|
+
fi
|
|
93
|
+
echo -e "${YELLOW}└─────────────────────────────────────────────────────────────────────────┘${NC}"
|
|
94
|
+
echo
|
|
95
|
+
fi
|
|
96
|
+
fi
|
|
97
|
+
|
|
98
|
+
# Recent logs
|
|
99
|
+
echo -e "${BLUE}┌─ Recent Activity ───────────────────────────────────────────────────────┐${NC}"
|
|
100
|
+
if [[ -f "$LOG_FILE" ]]; then
|
|
101
|
+
tail -n 8 "$LOG_FILE" | while IFS= read -r line; do
|
|
102
|
+
echo -e "${BLUE}│${NC} $line"
|
|
103
|
+
done
|
|
104
|
+
else
|
|
105
|
+
echo -e "${BLUE}│${NC} No log file found"
|
|
106
|
+
fi
|
|
107
|
+
echo -e "${BLUE}└─────────────────────────────────────────────────────────────────────────┘${NC}"
|
|
108
|
+
|
|
109
|
+
# Footer
|
|
110
|
+
echo
|
|
111
|
+
echo -e "${YELLOW}Controls: Ctrl+C to exit | Refreshes every ${REFRESH_INTERVAL}s | $(date '+%H:%M:%S')${NC}"
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
# Main monitor loop
|
|
115
|
+
main() {
|
|
116
|
+
echo "Starting Ralph Monitor..."
|
|
117
|
+
sleep 2
|
|
118
|
+
|
|
119
|
+
while true; do
|
|
120
|
+
display_status
|
|
121
|
+
sleep "$REFRESH_INTERVAL"
|
|
122
|
+
done
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
main
|
package/ralph/templates/AGENT.md
CHANGED
|
@@ -1,158 +1,158 @@
|
|
|
1
|
-
# Agent Build Instructions
|
|
2
|
-
|
|
3
|
-
## Project Setup
|
|
4
|
-
```bash
|
|
5
|
-
# Install dependencies (example for Node.js project)
|
|
6
|
-
npm install
|
|
7
|
-
|
|
8
|
-
# Or for Python project
|
|
9
|
-
pip install -r requirements.txt
|
|
10
|
-
|
|
11
|
-
# Or for Rust project
|
|
12
|
-
cargo build
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Running Tests
|
|
16
|
-
```bash
|
|
17
|
-
# Node.js
|
|
18
|
-
npm test
|
|
19
|
-
|
|
20
|
-
# Python
|
|
21
|
-
pytest
|
|
22
|
-
|
|
23
|
-
# Rust
|
|
24
|
-
cargo test
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
## Build Commands
|
|
28
|
-
```bash
|
|
29
|
-
# Production build
|
|
30
|
-
npm run build
|
|
31
|
-
# or
|
|
32
|
-
cargo build --release
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
## Development Server
|
|
36
|
-
```bash
|
|
37
|
-
# Start development server
|
|
38
|
-
npm run dev
|
|
39
|
-
# or
|
|
40
|
-
cargo run
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
## Key Learnings
|
|
44
|
-
- Update this section when you learn new build optimizations
|
|
45
|
-
- Document any gotchas or special setup requirements
|
|
46
|
-
- Keep track of the fastest test/build cycle
|
|
47
|
-
|
|
48
|
-
## Feature Development Quality Standards
|
|
49
|
-
|
|
50
|
-
**CRITICAL**: All new features MUST meet the following mandatory requirements before being considered complete.
|
|
51
|
-
|
|
52
|
-
### Testing Requirements
|
|
53
|
-
|
|
54
|
-
- **Minimum Coverage**: 85% code coverage ratio required for all new code
|
|
55
|
-
- **Test Pass Rate**: 100% - all tests must pass, no exceptions
|
|
56
|
-
- **Test Types Required**:
|
|
57
|
-
- Unit tests for all business logic and services
|
|
58
|
-
- Integration tests for API endpoints or main functionality
|
|
59
|
-
- End-to-end tests for critical user workflows
|
|
60
|
-
- **Coverage Validation**: Run coverage reports before marking features complete:
|
|
61
|
-
```bash
|
|
62
|
-
# Examples by language/framework
|
|
63
|
-
npm run test:coverage
|
|
64
|
-
pytest --cov=src tests/ --cov-report=term-missing
|
|
65
|
-
cargo tarpaulin --out Html
|
|
66
|
-
```
|
|
67
|
-
- **Test Quality**: Tests must validate behavior, not just achieve coverage metrics
|
|
68
|
-
- **Test Documentation**: Complex test scenarios must include comments explaining the test strategy
|
|
69
|
-
|
|
70
|
-
### Git Workflow Requirements
|
|
71
|
-
|
|
72
|
-
Before moving to the next feature, ALL changes must be:
|
|
73
|
-
|
|
74
|
-
1. **Committed with Clear Messages**:
|
|
75
|
-
```bash
|
|
76
|
-
git add .
|
|
77
|
-
git commit -m "feat(module): descriptive message following conventional commits"
|
|
78
|
-
```
|
|
79
|
-
- Use conventional commit format: `feat:`, `fix:`, `docs:`, `test:`, `refactor:`, etc.
|
|
80
|
-
- Include scope when applicable: `feat(api):`, `fix(ui):`, `test(auth):`
|
|
81
|
-
- Write descriptive messages that explain WHAT changed and WHY
|
|
82
|
-
|
|
83
|
-
2. **Pushed to Remote Repository**:
|
|
84
|
-
```bash
|
|
85
|
-
git push origin <branch-name>
|
|
86
|
-
```
|
|
87
|
-
- Never leave completed features uncommitted
|
|
88
|
-
- Push regularly to maintain backup and enable collaboration
|
|
89
|
-
- Ensure CI/CD pipelines pass before considering feature complete
|
|
90
|
-
|
|
91
|
-
3. **Branch Hygiene**:
|
|
92
|
-
- Work on feature branches, never directly on `main`
|
|
93
|
-
- Branch naming convention: `feature/<feature-name>`, `fix/<issue-name>`, `docs/<doc-update>`
|
|
94
|
-
- Create pull requests for all significant changes
|
|
95
|
-
|
|
96
|
-
4. **Ralph Integration**:
|
|
97
|
-
- Update .ralph
|
|
98
|
-
- Mark items complete in .ralph
|
|
99
|
-
- Update .ralph/PROMPT.md if development patterns change
|
|
100
|
-
- Test features work within Ralph's autonomous loop
|
|
101
|
-
|
|
102
|
-
### Documentation Requirements
|
|
103
|
-
|
|
104
|
-
**ALL implementation documentation MUST remain synchronized with the codebase**:
|
|
105
|
-
|
|
106
|
-
1. **Code Documentation**:
|
|
107
|
-
- Language-appropriate documentation (JSDoc, docstrings, etc.)
|
|
108
|
-
- Update inline comments when implementation changes
|
|
109
|
-
- Remove outdated comments immediately
|
|
110
|
-
|
|
111
|
-
2. **Implementation Documentation**:
|
|
112
|
-
- Update relevant sections in this AGENT.md file
|
|
113
|
-
- Keep build and test commands current
|
|
114
|
-
- Update configuration examples when defaults change
|
|
115
|
-
- Document breaking changes prominently
|
|
116
|
-
|
|
117
|
-
3. **README Updates**:
|
|
118
|
-
- Keep feature lists current
|
|
119
|
-
- Update setup instructions when dependencies change
|
|
120
|
-
- Maintain accurate command examples
|
|
121
|
-
- Update version compatibility information
|
|
122
|
-
|
|
123
|
-
4. **AGENT.md Maintenance**:
|
|
124
|
-
- Add new build patterns to relevant sections
|
|
125
|
-
- Update "Key Learnings" with new insights
|
|
126
|
-
- Keep command examples accurate and tested
|
|
127
|
-
- Document new testing patterns or quality gates
|
|
128
|
-
|
|
129
|
-
### Feature Completion Checklist
|
|
130
|
-
|
|
131
|
-
Before marking ANY feature as complete, verify:
|
|
132
|
-
|
|
133
|
-
- [ ] All tests pass with appropriate framework command
|
|
134
|
-
- [ ] Code coverage meets 85% minimum threshold
|
|
135
|
-
- [ ] Coverage report reviewed for meaningful test quality
|
|
136
|
-
- [ ] Code formatted according to project standards
|
|
137
|
-
- [ ] Type checking passes (if applicable)
|
|
138
|
-
- [ ] All changes committed with conventional commit messages
|
|
139
|
-
- [ ] All commits pushed to remote repository
|
|
140
|
-
- [ ] .ralph
|
|
141
|
-
- [ ] Implementation documentation updated
|
|
142
|
-
- [ ] Inline code comments updated or added
|
|
143
|
-
- [ ] .ralph
|
|
144
|
-
- [ ] Breaking changes documented
|
|
145
|
-
- [ ] Features tested within Ralph loop (if applicable)
|
|
146
|
-
- [ ] CI/CD pipeline passes
|
|
147
|
-
|
|
148
|
-
### Rationale
|
|
149
|
-
|
|
150
|
-
These standards ensure:
|
|
151
|
-
- **Quality**: High test coverage and pass rates prevent regressions
|
|
152
|
-
- **Traceability**: Git commits and .ralph
|
|
153
|
-
- **Maintainability**: Current documentation reduces onboarding time and prevents knowledge loss
|
|
154
|
-
- **Collaboration**: Pushed changes enable team visibility and code review
|
|
155
|
-
- **Reliability**: Consistent quality gates maintain production stability
|
|
156
|
-
- **Automation**: Ralph integration ensures continuous development practices
|
|
157
|
-
|
|
158
|
-
**Enforcement**: AI agents should automatically apply these standards to all feature development tasks without requiring explicit instruction for each task.
|
|
1
|
+
# Agent Build Instructions
|
|
2
|
+
|
|
3
|
+
## Project Setup
|
|
4
|
+
```bash
|
|
5
|
+
# Install dependencies (example for Node.js project)
|
|
6
|
+
npm install
|
|
7
|
+
|
|
8
|
+
# Or for Python project
|
|
9
|
+
pip install -r requirements.txt
|
|
10
|
+
|
|
11
|
+
# Or for Rust project
|
|
12
|
+
cargo build
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Running Tests
|
|
16
|
+
```bash
|
|
17
|
+
# Node.js
|
|
18
|
+
npm test
|
|
19
|
+
|
|
20
|
+
# Python
|
|
21
|
+
pytest
|
|
22
|
+
|
|
23
|
+
# Rust
|
|
24
|
+
cargo test
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Build Commands
|
|
28
|
+
```bash
|
|
29
|
+
# Production build
|
|
30
|
+
npm run build
|
|
31
|
+
# or
|
|
32
|
+
cargo build --release
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Development Server
|
|
36
|
+
```bash
|
|
37
|
+
# Start development server
|
|
38
|
+
npm run dev
|
|
39
|
+
# or
|
|
40
|
+
cargo run
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Key Learnings
|
|
44
|
+
- Update this section when you learn new build optimizations
|
|
45
|
+
- Document any gotchas or special setup requirements
|
|
46
|
+
- Keep track of the fastest test/build cycle
|
|
47
|
+
|
|
48
|
+
## Feature Development Quality Standards
|
|
49
|
+
|
|
50
|
+
**CRITICAL**: All new features MUST meet the following mandatory requirements before being considered complete.
|
|
51
|
+
|
|
52
|
+
### Testing Requirements
|
|
53
|
+
|
|
54
|
+
- **Minimum Coverage**: 85% code coverage ratio required for all new code
|
|
55
|
+
- **Test Pass Rate**: 100% - all tests must pass, no exceptions
|
|
56
|
+
- **Test Types Required**:
|
|
57
|
+
- Unit tests for all business logic and services
|
|
58
|
+
- Integration tests for API endpoints or main functionality
|
|
59
|
+
- End-to-end tests for critical user workflows
|
|
60
|
+
- **Coverage Validation**: Run coverage reports before marking features complete:
|
|
61
|
+
```bash
|
|
62
|
+
# Examples by language/framework
|
|
63
|
+
npm run test:coverage
|
|
64
|
+
pytest --cov=src tests/ --cov-report=term-missing
|
|
65
|
+
cargo tarpaulin --out Html
|
|
66
|
+
```
|
|
67
|
+
- **Test Quality**: Tests must validate behavior, not just achieve coverage metrics
|
|
68
|
+
- **Test Documentation**: Complex test scenarios must include comments explaining the test strategy
|
|
69
|
+
|
|
70
|
+
### Git Workflow Requirements
|
|
71
|
+
|
|
72
|
+
Before moving to the next feature, ALL changes must be:
|
|
73
|
+
|
|
74
|
+
1. **Committed with Clear Messages**:
|
|
75
|
+
```bash
|
|
76
|
+
git add .
|
|
77
|
+
git commit -m "feat(module): descriptive message following conventional commits"
|
|
78
|
+
```
|
|
79
|
+
- Use conventional commit format: `feat:`, `fix:`, `docs:`, `test:`, `refactor:`, etc.
|
|
80
|
+
- Include scope when applicable: `feat(api):`, `fix(ui):`, `test(auth):`
|
|
81
|
+
- Write descriptive messages that explain WHAT changed and WHY
|
|
82
|
+
|
|
83
|
+
2. **Pushed to Remote Repository**:
|
|
84
|
+
```bash
|
|
85
|
+
git push origin <branch-name>
|
|
86
|
+
```
|
|
87
|
+
- Never leave completed features uncommitted
|
|
88
|
+
- Push regularly to maintain backup and enable collaboration
|
|
89
|
+
- Ensure CI/CD pipelines pass before considering feature complete
|
|
90
|
+
|
|
91
|
+
3. **Branch Hygiene**:
|
|
92
|
+
- Work on feature branches, never directly on `main`
|
|
93
|
+
- Branch naming convention: `feature/<feature-name>`, `fix/<issue-name>`, `docs/<doc-update>`
|
|
94
|
+
- Create pull requests for all significant changes
|
|
95
|
+
|
|
96
|
+
4. **Ralph Integration**:
|
|
97
|
+
- Update .ralph/fix_plan.md with new tasks before starting work
|
|
98
|
+
- Mark items complete in .ralph/fix_plan.md upon completion
|
|
99
|
+
- Update .ralph/PROMPT.md if development patterns change
|
|
100
|
+
- Test features work within Ralph's autonomous loop
|
|
101
|
+
|
|
102
|
+
### Documentation Requirements
|
|
103
|
+
|
|
104
|
+
**ALL implementation documentation MUST remain synchronized with the codebase**:
|
|
105
|
+
|
|
106
|
+
1. **Code Documentation**:
|
|
107
|
+
- Language-appropriate documentation (JSDoc, docstrings, etc.)
|
|
108
|
+
- Update inline comments when implementation changes
|
|
109
|
+
- Remove outdated comments immediately
|
|
110
|
+
|
|
111
|
+
2. **Implementation Documentation**:
|
|
112
|
+
- Update relevant sections in this AGENT.md file
|
|
113
|
+
- Keep build and test commands current
|
|
114
|
+
- Update configuration examples when defaults change
|
|
115
|
+
- Document breaking changes prominently
|
|
116
|
+
|
|
117
|
+
3. **README Updates**:
|
|
118
|
+
- Keep feature lists current
|
|
119
|
+
- Update setup instructions when dependencies change
|
|
120
|
+
- Maintain accurate command examples
|
|
121
|
+
- Update version compatibility information
|
|
122
|
+
|
|
123
|
+
4. **AGENT.md Maintenance**:
|
|
124
|
+
- Add new build patterns to relevant sections
|
|
125
|
+
- Update "Key Learnings" with new insights
|
|
126
|
+
- Keep command examples accurate and tested
|
|
127
|
+
- Document new testing patterns or quality gates
|
|
128
|
+
|
|
129
|
+
### Feature Completion Checklist
|
|
130
|
+
|
|
131
|
+
Before marking ANY feature as complete, verify:
|
|
132
|
+
|
|
133
|
+
- [ ] All tests pass with appropriate framework command
|
|
134
|
+
- [ ] Code coverage meets 85% minimum threshold
|
|
135
|
+
- [ ] Coverage report reviewed for meaningful test quality
|
|
136
|
+
- [ ] Code formatted according to project standards
|
|
137
|
+
- [ ] Type checking passes (if applicable)
|
|
138
|
+
- [ ] All changes committed with conventional commit messages
|
|
139
|
+
- [ ] All commits pushed to remote repository
|
|
140
|
+
- [ ] .ralph/fix_plan.md task marked as complete
|
|
141
|
+
- [ ] Implementation documentation updated
|
|
142
|
+
- [ ] Inline code comments updated or added
|
|
143
|
+
- [ ] .ralph/AGENT.md updated (if new patterns introduced)
|
|
144
|
+
- [ ] Breaking changes documented
|
|
145
|
+
- [ ] Features tested within Ralph loop (if applicable)
|
|
146
|
+
- [ ] CI/CD pipeline passes
|
|
147
|
+
|
|
148
|
+
### Rationale
|
|
149
|
+
|
|
150
|
+
These standards ensure:
|
|
151
|
+
- **Quality**: High test coverage and pass rates prevent regressions
|
|
152
|
+
- **Traceability**: Git commits and .ralph/fix_plan.md provide clear history of changes
|
|
153
|
+
- **Maintainability**: Current documentation reduces onboarding time and prevents knowledge loss
|
|
154
|
+
- **Collaboration**: Pushed changes enable team visibility and code review
|
|
155
|
+
- **Reliability**: Consistent quality gates maintain production stability
|
|
156
|
+
- **Automation**: Ralph integration ensures continuous development practices
|
|
157
|
+
|
|
158
|
+
**Enforcement**: AI agents should automatically apply these standards to all feature development tasks without requiring explicit instruction for each task.
|