siesa-agents 2.1.40 → 2.1.41

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (552) hide show
  1. package/README.md +147 -147
  2. package/bin/install.js +534 -534
  3. package/bin/prepare-publish.js +26 -26
  4. package/bin/restore-folders.js +26 -26
  5. package/bmad/_config/agent-manifest.csv +20 -20
  6. package/bmad/_config/agents/bmb-agent-builder.customize.yaml +41 -41
  7. package/bmad/_config/agents/bmb-module-builder.customize.yaml +41 -41
  8. package/bmad/_config/agents/bmb-workflow-builder.customize.yaml +41 -41
  9. package/bmad/_config/files-manifest.csv +469 -469
  10. package/bmad/_config/ides/claude-code.yaml +6 -6
  11. package/bmad/_config/manifest.yaml +14 -14
  12. package/bmad/_config/task-manifest.csv +6 -6
  13. package/bmad/_config/tool-manifest.csv +1 -1
  14. package/bmad/_config/workflow-manifest.csv +45 -45
  15. package/bmad/_memory/config.yaml +11 -11
  16. package/bmad/bmb/README.md +25 -25
  17. package/bmad/bmb/agents/agent-builder.md +57 -57
  18. package/bmad/bmb/agents/module-builder.md +60 -60
  19. package/bmad/bmb/agents/workflow-builder.md +56 -56
  20. package/bmad/bmb/config.yaml +12 -12
  21. package/bmad/bmb/docs/workflows/architecture.md +220 -220
  22. package/bmad/bmb/docs/workflows/common-workflow-tools.csv +18 -18
  23. package/bmad/bmb/docs/workflows/csv-data-file-standards.md +206 -206
  24. package/bmad/bmb/docs/workflows/intent-vs-prescriptive-spectrum.md +220 -220
  25. package/bmad/bmb/docs/workflows/step-file-rules.md +469 -469
  26. package/bmad/bmb/docs/workflows/templates/step-01-init-continuable-template.md +241 -241
  27. package/bmad/bmb/docs/workflows/templates/step-1b-template.md +223 -223
  28. package/bmad/bmb/docs/workflows/templates/step-file.md +139 -139
  29. package/bmad/bmb/docs/workflows/templates/step-template.md +290 -290
  30. package/bmad/bmb/docs/workflows/templates/workflow-template.md +104 -104
  31. package/bmad/bmb/docs/workflows/templates/workflow.md +58 -58
  32. package/bmad/bmb/docs/workflows/terms.md +97 -97
  33. package/bmad/bmb/reference/agents/simple-examples/README.md +223 -223
  34. package/bmad/bmb/reference/readme.md +3 -3
  35. package/bmad/bmb/reference/workflows/meal-prep-nutrition/data/dietary-restrictions.csv +17 -17
  36. package/bmad/bmb/reference/workflows/meal-prep-nutrition/data/macro-calculator.csv +15 -15
  37. package/bmad/bmb/reference/workflows/meal-prep-nutrition/data/recipe-database.csv +27 -27
  38. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01-init.md +177 -177
  39. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-01b-continue.md +121 -121
  40. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-02-profile.md +165 -165
  41. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-03-assessment.md +154 -154
  42. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-04-strategy.md +183 -183
  43. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-05-shopping.md +168 -168
  44. package/bmad/bmb/reference/workflows/meal-prep-nutrition/steps/step-06-prep-schedule.md +195 -195
  45. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/assessment-section.md +25 -25
  46. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/nutrition-plan.md +68 -68
  47. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/prep-schedule-section.md +29 -29
  48. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/profile-section.md +47 -47
  49. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/shopping-section.md +37 -37
  50. package/bmad/bmb/reference/workflows/meal-prep-nutrition/templates/strategy-section.md +18 -18
  51. package/bmad/bmb/reference/workflows/meal-prep-nutrition/workflow.md +59 -59
  52. package/bmad/bmb/workflows/agent/data/agent-compilation.md +273 -273
  53. package/bmad/bmb/workflows/agent/data/agent-menu-patterns.md +233 -233
  54. package/bmad/bmb/workflows/agent/data/agent-metadata.md +208 -208
  55. package/bmad/bmb/workflows/agent/data/brainstorm-context.md +146 -146
  56. package/bmad/bmb/workflows/agent/data/communication-presets.csv +61 -61
  57. package/bmad/bmb/workflows/agent/data/critical-actions.md +120 -120
  58. package/bmad/bmb/workflows/agent/data/expert-agent-architecture.md +236 -236
  59. package/bmad/bmb/workflows/agent/data/expert-agent-validation.md +173 -173
  60. package/bmad/bmb/workflows/agent/data/module-agent-validation.md +124 -124
  61. package/bmad/bmb/workflows/agent/data/persona-properties.md +266 -266
  62. package/bmad/bmb/workflows/agent/data/principles-crafting.md +292 -292
  63. package/bmad/bmb/workflows/agent/data/reference/expert-examples/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md +16 -16
  64. package/bmad/bmb/workflows/agent/data/reference/module-examples/architect.md +68 -68
  65. package/bmad/bmb/workflows/agent/data/simple-agent-architecture.md +204 -204
  66. package/bmad/bmb/workflows/agent/data/simple-agent-validation.md +132 -132
  67. package/bmad/bmb/workflows/agent/data/understanding-agent-types.md +222 -222
  68. package/bmad/bmb/workflows/agent/steps-c/step-01-brainstorm.md +126 -126
  69. package/bmad/bmb/workflows/agent/steps-c/step-02-discovery.md +168 -168
  70. package/bmad/bmb/workflows/agent/steps-c/step-03-type-metadata.md +294 -294
  71. package/bmad/bmb/workflows/agent/steps-c/step-04-persona.md +210 -210
  72. package/bmad/bmb/workflows/agent/steps-c/step-05-commands-menu.md +176 -176
  73. package/bmad/bmb/workflows/agent/steps-c/step-06-activation.md +275 -275
  74. package/bmad/bmb/workflows/agent/steps-c/step-07a-build-simple.md +185 -185
  75. package/bmad/bmb/workflows/agent/steps-c/step-07b-build-expert.md +201 -201
  76. package/bmad/bmb/workflows/agent/steps-c/step-07c-build-module.md +258 -258
  77. package/bmad/bmb/workflows/agent/steps-c/step-08a-plan-traceability.md +203 -203
  78. package/bmad/bmb/workflows/agent/steps-c/step-08b-metadata-validation.md +135 -135
  79. package/bmad/bmb/workflows/agent/steps-c/step-08c-persona-validation.md +161 -161
  80. package/bmad/bmb/workflows/agent/steps-c/step-08d-menu-validation.md +158 -158
  81. package/bmad/bmb/workflows/agent/steps-c/step-08e-structure-validation.md +306 -306
  82. package/bmad/bmb/workflows/agent/steps-c/step-08f-sidecar-validation.md +462 -462
  83. package/bmad/bmb/workflows/agent/steps-c/step-09-celebrate.md +244 -244
  84. package/bmad/bmb/workflows/agent/steps-e/e-01-load-existing.md +214 -214
  85. package/bmad/bmb/workflows/agent/steps-e/e-02-discover-edits.md +191 -191
  86. package/bmad/bmb/workflows/agent/steps-e/e-03a-validate-metadata.md +78 -78
  87. package/bmad/bmb/workflows/agent/steps-e/e-03b-validate-persona.md +76 -76
  88. package/bmad/bmb/workflows/agent/steps-e/e-03c-validate-menu.md +75 -75
  89. package/bmad/bmb/workflows/agent/steps-e/e-03d-validate-structure.md +75 -75
  90. package/bmad/bmb/workflows/agent/steps-e/e-03e-validate-sidecar.md +78 -78
  91. package/bmad/bmb/workflows/agent/steps-e/e-03f-validation-summary.md +119 -119
  92. package/bmad/bmb/workflows/agent/steps-e/e-04-type-metadata.md +122 -122
  93. package/bmad/bmb/workflows/agent/steps-e/e-05-persona.md +132 -132
  94. package/bmad/bmb/workflows/agent/steps-e/e-06-commands-menu.md +120 -120
  95. package/bmad/bmb/workflows/agent/steps-e/e-07-activation.md +122 -122
  96. package/bmad/bmb/workflows/agent/steps-e/e-08a-edit-simple.md +134 -134
  97. package/bmad/bmb/workflows/agent/steps-e/e-08b-edit-expert.md +117 -117
  98. package/bmad/bmb/workflows/agent/steps-e/e-08c-edit-module.md +120 -120
  99. package/bmad/bmb/workflows/agent/steps-e/e-09a-validate-metadata.md +70 -70
  100. package/bmad/bmb/workflows/agent/steps-e/e-09b-validate-persona.md +70 -70
  101. package/bmad/bmb/workflows/agent/steps-e/e-09c-validate-menu.md +69 -69
  102. package/bmad/bmb/workflows/agent/steps-e/e-09d-validate-structure.md +69 -69
  103. package/bmad/bmb/workflows/agent/steps-e/e-09e-validate-sidecar.md +70 -70
  104. package/bmad/bmb/workflows/agent/steps-e/e-09f-validation-summary.md +111 -111
  105. package/bmad/bmb/workflows/agent/steps-e/e-10-celebrate.md +150 -150
  106. package/bmad/bmb/workflows/agent/steps-v/v-01-load-review.md +128 -128
  107. package/bmad/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md +73 -73
  108. package/bmad/bmb/workflows/agent/steps-v/v-02b-validate-persona.md +72 -72
  109. package/bmad/bmb/workflows/agent/steps-v/v-02c-validate-menu.md +71 -71
  110. package/bmad/bmb/workflows/agent/steps-v/v-02d-validate-structure.md +71 -71
  111. package/bmad/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md +76 -76
  112. package/bmad/bmb/workflows/agent/steps-v/v-03-summary.md +100 -100
  113. package/bmad/bmb/workflows/agent/templates/agent-plan.template.md +5 -5
  114. package/bmad/bmb/workflows/agent/templates/expert-agent-template/expert-agent.template.md +76 -76
  115. package/bmad/bmb/workflows/agent/templates/simple-agent.template.md +71 -71
  116. package/bmad/bmb/workflows/agent/workflow.md +123 -123
  117. package/bmad/bmb/workflows/create-module/steps/step-01-init.md +156 -156
  118. package/bmad/bmb/workflows/create-module/steps/step-01b-continue.md +170 -170
  119. package/bmad/bmb/workflows/create-module/steps/step-02-concept.md +218 -218
  120. package/bmad/bmb/workflows/create-module/steps/step-03-components.md +268 -268
  121. package/bmad/bmb/workflows/create-module/steps/step-04-structure.md +229 -229
  122. package/bmad/bmb/workflows/create-module/steps/step-05-config.md +234 -234
  123. package/bmad/bmb/workflows/create-module/steps/step-06-agents.md +297 -297
  124. package/bmad/bmb/workflows/create-module/steps/step-07-workflows.md +229 -229
  125. package/bmad/bmb/workflows/create-module/steps/step-08-installer.md +187 -187
  126. package/bmad/bmb/workflows/create-module/steps/step-09-documentation.md +310 -310
  127. package/bmad/bmb/workflows/create-module/steps/step-10-roadmap.md +338 -338
  128. package/bmad/bmb/workflows/create-module/steps/step-11-validate.md +336 -336
  129. package/bmad/bmb/workflows/create-module/templates/agent.template.md +313 -313
  130. package/bmad/bmb/workflows/create-module/templates/installer.template.js +47 -47
  131. package/bmad/bmb/workflows/create-module/templates/module-plan.template.md +5 -5
  132. package/bmad/bmb/workflows/create-module/templates/module.template.yaml +53 -53
  133. package/bmad/bmb/workflows/create-module/templates/workflow-plan-template.md +23 -23
  134. package/bmad/bmb/workflows/create-module/validation.md +126 -126
  135. package/bmad/bmb/workflows/create-module/workflow.md +56 -56
  136. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/dietary-restrictions.csv +17 -17
  137. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/macro-calculator.csv +15 -15
  138. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/data/recipe-database.csv +27 -27
  139. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01-init.md +177 -177
  140. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-01b-continue.md +150 -150
  141. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-02-profile.md +164 -164
  142. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-03-assessment.md +152 -152
  143. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-04-strategy.md +182 -182
  144. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-05-shopping.md +167 -167
  145. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/steps/step-06-prep-schedule.md +194 -194
  146. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/assessment-section.md +25 -25
  147. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/nutrition-plan.md +68 -68
  148. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/prep-schedule-section.md +29 -29
  149. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/profile-section.md +47 -47
  150. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/shopping-section.md +37 -37
  151. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/templates/strategy-section.md +18 -18
  152. package/bmad/bmb/workflows/create-workflow/data/examples/meal-prep-nutrition/workflow.md +58 -58
  153. package/bmad/bmb/workflows/create-workflow/steps/step-01-init.md +158 -158
  154. package/bmad/bmb/workflows/create-workflow/steps/step-02-gather.md +212 -212
  155. package/bmad/bmb/workflows/create-workflow/steps/step-03-tools-configuration.md +251 -251
  156. package/bmad/bmb/workflows/create-workflow/steps/step-04-plan-review.md +217 -217
  157. package/bmad/bmb/workflows/create-workflow/steps/step-05-output-format-design.md +290 -290
  158. package/bmad/bmb/workflows/create-workflow/steps/step-06-design.md +272 -272
  159. package/bmad/bmb/workflows/create-workflow/steps/step-07-build.md +323 -323
  160. package/bmad/bmb/workflows/create-workflow/steps/step-08-review.md +285 -285
  161. package/bmad/bmb/workflows/create-workflow/steps/step-09-complete.md +188 -188
  162. package/bmad/bmb/workflows/create-workflow/workflow.md +59 -59
  163. package/bmad/bmb/workflows/edit-workflow/steps/step-01-analyze.md +217 -217
  164. package/bmad/bmb/workflows/edit-workflow/steps/step-02-discover.md +254 -254
  165. package/bmad/bmb/workflows/edit-workflow/steps/step-03-improve.md +218 -218
  166. package/bmad/bmb/workflows/edit-workflow/steps/step-04-validate.md +194 -194
  167. package/bmad/bmb/workflows/edit-workflow/steps/step-05-compliance-check.md +246 -246
  168. package/bmad/bmb/workflows/edit-workflow/templates/completion-summary.md +75 -75
  169. package/bmad/bmb/workflows/edit-workflow/templates/improvement-goals.md +68 -68
  170. package/bmad/bmb/workflows/edit-workflow/templates/improvement-log.md +40 -40
  171. package/bmad/bmb/workflows/edit-workflow/templates/validation-results.md +51 -51
  172. package/bmad/bmb/workflows/edit-workflow/templates/workflow-analysis.md +56 -56
  173. package/bmad/bmb/workflows/edit-workflow/workflow.md +59 -59
  174. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-01-validate-goal.md +153 -153
  175. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-02-workflow-validation.md +244 -244
  176. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-03-step-validation.md +275 -275
  177. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-04-file-validation.md +296 -296
  178. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-05-intent-spectrum-validation.md +265 -265
  179. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-06-web-subprocess-validation.md +361 -361
  180. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-07-holistic-analysis.md +259 -259
  181. package/bmad/bmb/workflows/workflow-compliance-check/steps/step-08-generate-report.md +302 -302
  182. package/bmad/bmb/workflows/workflow-compliance-check/templates/compliance-report.md +140 -140
  183. package/bmad/bmb/workflows/workflow-compliance-check/workflow.md +59 -59
  184. package/bmad/bmb/workflows-legacy/edit-module/README.md +171 -171
  185. package/bmad/bmb/workflows-legacy/edit-module/checklist.md +163 -163
  186. package/bmad/bmb/workflows-legacy/edit-module/instructions.md +340 -340
  187. package/bmad/bmb/workflows-legacy/edit-module/workflow.yaml +32 -32
  188. package/bmad/bmb/workflows-legacy/module-brief/README.md +264 -264
  189. package/bmad/bmb/workflows-legacy/module-brief/checklist.md +116 -116
  190. package/bmad/bmb/workflows-legacy/module-brief/instructions.md +268 -268
  191. package/bmad/bmb/workflows-legacy/module-brief/template.md +275 -275
  192. package/bmad/bmb/workflows-legacy/module-brief/workflow.yaml +34 -34
  193. package/bmad/bmm/agents/analyst.md +76 -76
  194. package/bmad/bmm/agents/architect.md +68 -68
  195. package/bmad/bmm/agents/dev.md +70 -70
  196. package/bmad/bmm/agents/pm.md +70 -70
  197. package/bmad/bmm/agents/quick-flow-solo-dev.md +68 -68
  198. package/bmad/bmm/agents/sm.md +71 -71
  199. package/bmad/bmm/agents/tea.md +71 -71
  200. package/bmad/bmm/agents/tech-writer.md +72 -72
  201. package/bmad/bmm/agents/ux-designer.md +68 -68
  202. package/bmad/bmm/config.yaml +18 -18
  203. package/bmad/bmm/data/README.md +29 -29
  204. package/bmad/bmm/data/documentation-standards.md +262 -262
  205. package/bmad/bmm/data/project-context-template.md +40 -40
  206. package/bmad/bmm/teams/default-party.csv +21 -21
  207. package/bmad/bmm/teams/team-fullstack.yaml +12 -12
  208. package/bmad/bmm/testarch/knowledge/api-request.md +303 -303
  209. package/bmad/bmm/testarch/knowledge/auth-session.md +356 -356
  210. package/bmad/bmm/testarch/knowledge/burn-in.md +273 -273
  211. package/bmad/bmm/testarch/knowledge/ci-burn-in.md +675 -675
  212. package/bmad/bmm/testarch/knowledge/component-tdd.md +486 -486
  213. package/bmad/bmm/testarch/knowledge/contract-testing.md +957 -957
  214. package/bmad/bmm/testarch/knowledge/data-factories.md +500 -500
  215. package/bmad/bmm/testarch/knowledge/email-auth.md +721 -721
  216. package/bmad/bmm/testarch/knowledge/error-handling.md +725 -725
  217. package/bmad/bmm/testarch/knowledge/feature-flags.md +750 -750
  218. package/bmad/bmm/testarch/knowledge/file-utils.md +260 -260
  219. package/bmad/bmm/testarch/knowledge/fixture-architecture.md +401 -401
  220. package/bmad/bmm/testarch/knowledge/fixtures-composition.md +382 -382
  221. package/bmad/bmm/testarch/knowledge/intercept-network-call.md +280 -280
  222. package/bmad/bmm/testarch/knowledge/log.md +294 -294
  223. package/bmad/bmm/testarch/knowledge/network-error-monitor.md +272 -272
  224. package/bmad/bmm/testarch/knowledge/network-first.md +486 -486
  225. package/bmad/bmm/testarch/knowledge/network-recorder.md +265 -265
  226. package/bmad/bmm/testarch/knowledge/nfr-criteria.md +670 -670
  227. package/bmad/bmm/testarch/knowledge/overview.md +283 -283
  228. package/bmad/bmm/testarch/knowledge/playwright-config.md +730 -730
  229. package/bmad/bmm/testarch/knowledge/probability-impact.md +601 -601
  230. package/bmad/bmm/testarch/knowledge/recurse.md +296 -296
  231. package/bmad/bmm/testarch/knowledge/risk-governance.md +615 -615
  232. package/bmad/bmm/testarch/knowledge/selective-testing.md +732 -732
  233. package/bmad/bmm/testarch/knowledge/selector-resilience.md +527 -527
  234. package/bmad/bmm/testarch/knowledge/test-healing-patterns.md +644 -644
  235. package/bmad/bmm/testarch/knowledge/test-levels-framework.md +473 -473
  236. package/bmad/bmm/testarch/knowledge/test-priorities-matrix.md +373 -373
  237. package/bmad/bmm/testarch/knowledge/test-quality.md +664 -664
  238. package/bmad/bmm/testarch/knowledge/timing-debugging.md +372 -372
  239. package/bmad/bmm/testarch/knowledge/visual-debugging.md +524 -524
  240. package/bmad/bmm/testarch/tea-index.csv +33 -33
  241. package/bmad/bmm/workflows/1-analysis/create-product-brief/product-brief.template.md +10 -10
  242. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +182 -182
  243. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +166 -166
  244. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +204 -204
  245. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +207 -207
  246. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +210 -210
  247. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +224 -224
  248. package/bmad/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +199 -199
  249. package/bmad/bmm/workflows/1-analysis/create-product-brief/workflow.md +58 -58
  250. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +137 -137
  251. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +229 -229
  252. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +238 -238
  253. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +206 -206
  254. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +234 -234
  255. package/bmad/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +443 -443
  256. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +182 -182
  257. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +237 -237
  258. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-02-customer-insights.md +200 -200
  259. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +249 -249
  260. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +259 -259
  261. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +177 -177
  262. package/bmad/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +475 -475
  263. package/bmad/bmm/workflows/1-analysis/research/research.template.md +29 -29
  264. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +137 -137
  265. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +239 -239
  266. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +248 -248
  267. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +202 -202
  268. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +239 -239
  269. package/bmad/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +486 -486
  270. package/bmad/bmm/workflows/1-analysis/research/workflow.md +173 -173
  271. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01-init.md +135 -135
  272. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +127 -127
  273. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +190 -190
  274. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +216 -216
  275. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +219 -219
  276. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +234 -234
  277. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +252 -252
  278. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +254 -254
  279. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +224 -224
  280. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +224 -224
  281. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +241 -241
  282. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +248 -248
  283. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +237 -237
  284. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +264 -264
  285. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +228 -228
  286. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/ux-design-template.md +13 -13
  287. package/bmad/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +43 -43
  288. package/bmad/bmm/workflows/2-plan-workflows/prd/domain-complexity.csv +12 -12
  289. package/bmad/bmm/workflows/2-plan-workflows/prd/prd-template.md +11 -11
  290. package/bmad/bmm/workflows/2-plan-workflows/prd/project-types.csv +10 -10
  291. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-01-init.md +197 -197
  292. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-01b-continue.md +166 -166
  293. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-02-discovery.md +421 -421
  294. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-03-success.md +290 -290
  295. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-04-journeys.md +291 -291
  296. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-05-domain.md +271 -271
  297. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-06-innovation.md +262 -262
  298. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-07-project-type.md +258 -258
  299. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-08-scoping.md +299 -299
  300. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-09-functional.md +270 -270
  301. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-10-nonfunctional.md +294 -294
  302. package/bmad/bmm/workflows/2-plan-workflows/prd/steps/step-11-complete.md +186 -186
  303. package/bmad/bmm/workflows/2-plan-workflows/prd/workflow.md +63 -63
  304. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +190 -190
  305. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +178 -178
  306. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +179 -179
  307. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +139 -139
  308. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +252 -252
  309. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +133 -133
  310. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/templates/readiness-report-template.md +4 -4
  311. package/bmad/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +55 -55
  312. package/bmad/bmm/workflows/3-solutioning/create-architecture/architecture-decision-template.md +12 -12
  313. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/architecture-patterns.md +415 -415
  314. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/backend-standards.md +811 -811
  315. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/frontend-standards.md +375 -375
  316. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/technical-preferences-ux.md +422 -422
  317. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/company-standards/technology-stack.md +235 -235
  318. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/domain-complexity.csv +10 -10
  319. package/bmad/bmm/workflows/3-solutioning/create-architecture/data/project-types.csv +6 -6
  320. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01-init.md +166 -166
  321. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +164 -164
  322. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +224 -224
  323. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +342 -342
  324. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +328 -328
  325. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +368 -368
  326. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +379 -379
  327. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +366 -366
  328. package/bmad/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +352 -352
  329. package/bmad/bmm/workflows/3-solutioning/create-architecture/workflow.md +51 -51
  330. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-01-validate-prerequisites.md +259 -259
  331. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +233 -233
  332. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +272 -272
  333. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +145 -145
  334. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/templates/epics-template.md +57 -57
  335. package/bmad/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +59 -59
  336. package/bmad/bmm/workflows/4-implementation/code-review/checklist.md +23 -23
  337. package/bmad/bmm/workflows/4-implementation/code-review/instructions.xml +224 -224
  338. package/bmad/bmm/workflows/4-implementation/code-review/workflow.yaml +49 -49
  339. package/bmad/bmm/workflows/4-implementation/correct-course/checklist.md +279 -279
  340. package/bmad/bmm/workflows/4-implementation/correct-course/instructions.md +206 -206
  341. package/bmad/bmm/workflows/4-implementation/correct-course/workflow.yaml +58 -58
  342. package/bmad/bmm/workflows/4-implementation/create-story/checklist.md +358 -358
  343. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-01-determine-story.md +85 -85
  344. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-02-analyze.md +67 -67
  345. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-03-architecture.md +71 -71
  346. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-04-web-research.md +58 -58
  347. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-05-create-file.md +76 -76
  348. package/bmad/bmm/workflows/4-implementation/create-story/steps/step-06-finalize.md +66 -66
  349. package/bmad/bmm/workflows/4-implementation/create-story/template.md +49 -49
  350. package/bmad/bmm/workflows/4-implementation/create-story/workflow.md +58 -58
  351. package/bmad/bmm/workflows/4-implementation/create-story/workflow.yaml.bak +63 -63
  352. package/bmad/bmm/workflows/4-implementation/dev-story/checklist.md +85 -85
  353. package/bmad/bmm/workflows/4-implementation/dev-story/instructions.xml +470 -470
  354. package/bmad/bmm/workflows/4-implementation/dev-story/workflow.yaml +25 -25
  355. package/bmad/bmm/workflows/4-implementation/retrospective/instructions.md +1443 -1443
  356. package/bmad/bmm/workflows/4-implementation/retrospective/workflow.yaml +56 -56
  357. package/bmad/bmm/workflows/4-implementation/sprint-planning/checklist.md +33 -33
  358. package/bmad/bmm/workflows/4-implementation/sprint-planning/instructions.md +225 -225
  359. package/bmad/bmm/workflows/4-implementation/sprint-planning/sprint-status-template.yaml +55 -55
  360. package/bmad/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +52 -52
  361. package/bmad/bmm/workflows/4-implementation/sprint-status/instructions.md +229 -229
  362. package/bmad/bmm/workflows/4-implementation/sprint-status/workflow.yaml +34 -34
  363. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-01-understand.md +189 -189
  364. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-02-investigate.md +144 -144
  365. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-03-generate.md +128 -128
  366. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/steps/step-04-review.md +173 -173
  367. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/tech-spec-template.md +74 -74
  368. package/bmad/bmm/workflows/bmad-quick-flow/create-tech-spec/workflow.md +79 -79
  369. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +156 -156
  370. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +120 -120
  371. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +113 -113
  372. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +113 -113
  373. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +106 -106
  374. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +140 -140
  375. package/bmad/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +52 -52
  376. package/bmad/bmm/workflows/document-project/checklist.md +245 -245
  377. package/bmad/bmm/workflows/document-project/documentation-requirements.csv +12 -12
  378. package/bmad/bmm/workflows/document-project/instructions.md +221 -221
  379. package/bmad/bmm/workflows/document-project/templates/deep-dive-template.md +345 -345
  380. package/bmad/bmm/workflows/document-project/templates/index-template.md +169 -169
  381. package/bmad/bmm/workflows/document-project/templates/project-overview-template.md +103 -103
  382. package/bmad/bmm/workflows/document-project/templates/project-scan-report-schema.json +160 -160
  383. package/bmad/bmm/workflows/document-project/templates/source-tree-template.md +135 -135
  384. package/bmad/bmm/workflows/document-project/workflow.yaml +28 -28
  385. package/bmad/bmm/workflows/document-project/workflows/deep-dive-instructions.md +298 -298
  386. package/bmad/bmm/workflows/document-project/workflows/deep-dive.yaml +31 -31
  387. package/bmad/bmm/workflows/document-project/workflows/full-scan-instructions.md +1106 -1106
  388. package/bmad/bmm/workflows/document-project/workflows/full-scan.yaml +31 -31
  389. package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-library.json +90 -90
  390. package/bmad/bmm/workflows/excalidraw-diagrams/_shared/excalidraw-templates.yaml +127 -127
  391. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/checklist.md +39 -39
  392. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/instructions.md +130 -130
  393. package/bmad/bmm/workflows/excalidraw-diagrams/create-dataflow/workflow.yaml +25 -25
  394. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/checklist.md +43 -43
  395. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/instructions.md +141 -141
  396. package/bmad/bmm/workflows/excalidraw-diagrams/create-diagram/workflow.yaml +25 -25
  397. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/checklist.md +49 -49
  398. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/instructions.md +241 -241
  399. package/bmad/bmm/workflows/excalidraw-diagrams/create-flowchart/workflow.yaml +25 -25
  400. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/checklist.md +38 -38
  401. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/instructions.md +133 -133
  402. package/bmad/bmm/workflows/excalidraw-diagrams/create-wireframe/workflow.yaml +25 -25
  403. package/bmad/bmm/workflows/generate-project-context/project-context-template.md +21 -21
  404. package/bmad/bmm/workflows/generate-project-context/steps/step-01-discover.md +218 -218
  405. package/bmad/bmm/workflows/generate-project-context/steps/step-02-generate.md +318 -318
  406. package/bmad/bmm/workflows/generate-project-context/steps/step-03-complete.md +278 -278
  407. package/bmad/bmm/workflows/generate-project-context/workflow.md +50 -50
  408. package/bmad/bmm/workflows/testarch/atdd/atdd-checklist-template.md +364 -364
  409. package/bmad/bmm/workflows/testarch/atdd/checklist.md +374 -374
  410. package/bmad/bmm/workflows/testarch/atdd/instructions.md +806 -806
  411. package/bmad/bmm/workflows/testarch/atdd/workflow.yaml +45 -45
  412. package/bmad/bmm/workflows/testarch/automate/checklist.md +582 -582
  413. package/bmad/bmm/workflows/testarch/automate/instructions.md +1324 -1324
  414. package/bmad/bmm/workflows/testarch/automate/workflow.yaml +52 -52
  415. package/bmad/bmm/workflows/testarch/ci/checklist.md +248 -248
  416. package/bmad/bmm/workflows/testarch/ci/github-actions-template.yaml +198 -198
  417. package/bmad/bmm/workflows/testarch/ci/gitlab-ci-template.yaml +149 -149
  418. package/bmad/bmm/workflows/testarch/ci/instructions.md +536 -536
  419. package/bmad/bmm/workflows/testarch/ci/workflow.yaml +45 -45
  420. package/bmad/bmm/workflows/testarch/framework/checklist.md +321 -321
  421. package/bmad/bmm/workflows/testarch/framework/instructions.md +481 -481
  422. package/bmad/bmm/workflows/testarch/framework/workflow.yaml +47 -47
  423. package/bmad/bmm/workflows/testarch/nfr-assess/checklist.md +407 -407
  424. package/bmad/bmm/workflows/testarch/nfr-assess/instructions.md +722 -722
  425. package/bmad/bmm/workflows/testarch/nfr-assess/nfr-report-template.md +445 -445
  426. package/bmad/bmm/workflows/testarch/nfr-assess/workflow.yaml +47 -47
  427. package/bmad/bmm/workflows/testarch/test-design/checklist.md +235 -235
  428. package/bmad/bmm/workflows/testarch/test-design/instructions.md +788 -788
  429. package/bmad/bmm/workflows/testarch/test-design/test-design-template.md +294 -294
  430. package/bmad/bmm/workflows/testarch/test-design/workflow.yaml +54 -54
  431. package/bmad/bmm/workflows/testarch/test-review/checklist.md +472 -472
  432. package/bmad/bmm/workflows/testarch/test-review/instructions.md +628 -628
  433. package/bmad/bmm/workflows/testarch/test-review/test-review-template.md +390 -390
  434. package/bmad/bmm/workflows/testarch/test-review/workflow.yaml +46 -46
  435. package/bmad/bmm/workflows/testarch/trace/checklist.md +655 -655
  436. package/bmad/bmm/workflows/testarch/trace/instructions.md +1047 -1047
  437. package/bmad/bmm/workflows/testarch/trace/trace-template.md +675 -675
  438. package/bmad/bmm/workflows/testarch/trace/workflow.yaml +55 -55
  439. package/bmad/bmm/workflows/workflow-status/init/instructions.md +346 -346
  440. package/bmad/bmm/workflows/workflow-status/init/workflow.yaml +28 -28
  441. package/bmad/bmm/workflows/workflow-status/instructions.md +395 -395
  442. package/bmad/bmm/workflows/workflow-status/paths/enterprise-brownfield.yaml +103 -103
  443. package/bmad/bmm/workflows/workflow-status/paths/enterprise-greenfield.yaml +100 -100
  444. package/bmad/bmm/workflows/workflow-status/paths/method-brownfield.yaml +103 -103
  445. package/bmad/bmm/workflows/workflow-status/paths/method-greenfield.yaml +100 -100
  446. package/bmad/bmm/workflows/workflow-status/project-levels.yaml +59 -59
  447. package/bmad/bmm/workflows/workflow-status/workflow-status-template.yaml +24 -24
  448. package/bmad/bmm/workflows/workflow-status/workflow.yaml +30 -30
  449. package/bmad/cis/agents/brainstorming-coach.md +60 -60
  450. package/bmad/cis/agents/creative-problem-solver.md +60 -60
  451. package/bmad/cis/agents/design-thinking-coach.md +60 -60
  452. package/bmad/cis/agents/innovation-strategist.md +60 -60
  453. package/bmad/cis/agents/presentation-master.md +66 -66
  454. package/bmad/cis/agents/storyteller/storyteller.md +57 -57
  455. package/bmad/cis/config.yaml +11 -11
  456. package/bmad/cis/teams/creative-squad.yaml +7 -7
  457. package/bmad/cis/teams/default-party.csv +12 -12
  458. package/bmad/cis/workflows/README.md +139 -139
  459. package/bmad/cis/workflows/design-thinking/README.md +56 -56
  460. package/bmad/cis/workflows/design-thinking/design-methods.csv +30 -30
  461. package/bmad/cis/workflows/design-thinking/instructions.md +202 -202
  462. package/bmad/cis/workflows/design-thinking/template.md +111 -111
  463. package/bmad/cis/workflows/design-thinking/workflow.yaml +27 -27
  464. package/bmad/cis/workflows/innovation-strategy/README.md +56 -56
  465. package/bmad/cis/workflows/innovation-strategy/innovation-frameworks.csv +30 -30
  466. package/bmad/cis/workflows/innovation-strategy/instructions.md +276 -276
  467. package/bmad/cis/workflows/innovation-strategy/template.md +189 -189
  468. package/bmad/cis/workflows/innovation-strategy/workflow.yaml +27 -27
  469. package/bmad/cis/workflows/problem-solving/README.md +56 -56
  470. package/bmad/cis/workflows/problem-solving/instructions.md +252 -252
  471. package/bmad/cis/workflows/problem-solving/solving-methods.csv +30 -30
  472. package/bmad/cis/workflows/problem-solving/template.md +165 -165
  473. package/bmad/cis/workflows/problem-solving/workflow.yaml +27 -27
  474. package/bmad/cis/workflows/storytelling/README.md +58 -58
  475. package/bmad/cis/workflows/storytelling/instructions.md +293 -293
  476. package/bmad/cis/workflows/storytelling/story-types.csv +25 -25
  477. package/bmad/cis/workflows/storytelling/template.md +113 -113
  478. package/bmad/cis/workflows/storytelling/workflow.yaml +27 -27
  479. package/bmad/core/agents/bmad-master.md +57 -57
  480. package/bmad/core/config.yaml +9 -9
  481. package/bmad/core/resources/excalidraw/README.md +160 -160
  482. package/bmad/core/resources/excalidraw/excalidraw-helpers.md +127 -127
  483. package/bmad/core/resources/excalidraw/library-loader.md +50 -50
  484. package/bmad/core/resources/excalidraw/validate-json-instructions.md +79 -79
  485. package/bmad/core/tasks/index-docs.xml +64 -64
  486. package/bmad/core/tasks/review-adversarial-general.xml +41 -41
  487. package/bmad/core/tasks/shard-doc.xml +108 -108
  488. package/bmad/core/tasks/validate-workflow.xml +88 -88
  489. package/bmad/core/tasks/workflow.xml +234 -234
  490. package/bmad/core/workflows/advanced-elicitation/methods.csv +51 -51
  491. package/bmad/core/workflows/advanced-elicitation/workflow.xml +116 -116
  492. package/bmad/core/workflows/brainstorming/brain-methods.csv +61 -61
  493. package/bmad/core/workflows/brainstorming/steps/step-01-session-setup.md +197 -197
  494. package/bmad/core/workflows/brainstorming/steps/step-01b-continue.md +122 -122
  495. package/bmad/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -225
  496. package/bmad/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -237
  497. package/bmad/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -209
  498. package/bmad/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -264
  499. package/bmad/core/workflows/brainstorming/steps/step-03-technique-execution.md +340 -340
  500. package/bmad/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -303
  501. package/bmad/core/workflows/brainstorming/template.md +15 -15
  502. package/bmad/core/workflows/brainstorming/workflow.md +51 -51
  503. package/bmad/core/workflows/party-mode/steps/step-01-agent-loading.md +139 -139
  504. package/bmad/core/workflows/party-mode/steps/step-02-discussion-orchestration.md +204 -204
  505. package/bmad/core/workflows/party-mode/steps/step-03-graceful-exit.md +159 -159
  506. package/bmad/core/workflows/party-mode/workflow.md +206 -206
  507. package/claude/hooks/file-restriction-hook.py +51 -51
  508. package/claude/hooks/track-agent.py +67 -67
  509. package/claude/settings.local.json +76 -76
  510. package/gemini/commands/BMad/agents/analyst.toml +6 -0
  511. package/gemini/commands/BMad/agents/architect.toml +6 -0
  512. package/gemini/commands/BMad/agents/bmad-master.toml +6 -0
  513. package/gemini/commands/BMad/agents/bmad-orchestrator.toml +6 -0
  514. package/gemini/commands/BMad/agents/dev.toml +6 -0
  515. package/gemini/commands/BMad/agents/pm.toml +6 -0
  516. package/gemini/commands/BMad/agents/po.toml +6 -0
  517. package/gemini/commands/BMad/agents/qa.toml +6 -0
  518. package/gemini/commands/BMad/agents/sm.toml +6 -0
  519. package/gemini/commands/BMad/agents/ux-expert.toml +6 -0
  520. package/gemini/commands/BMad/tasks/advanced-elicitation.toml +6 -0
  521. package/gemini/commands/BMad/tasks/apply-qa-fixes.toml +6 -0
  522. package/gemini/commands/BMad/tasks/brownfield-create-epic.toml +6 -0
  523. package/gemini/commands/BMad/tasks/brownfield-create-story.toml +6 -0
  524. package/gemini/commands/BMad/tasks/correct-course.toml +6 -0
  525. package/gemini/commands/BMad/tasks/create-brownfield-story.toml +6 -0
  526. package/gemini/commands/BMad/tasks/create-deep-research-prompt.toml +6 -0
  527. package/gemini/commands/BMad/tasks/create-doc.toml +6 -0
  528. package/gemini/commands/BMad/tasks/create-next-story.toml +6 -0
  529. package/gemini/commands/BMad/tasks/document-project.toml +6 -0
  530. package/gemini/commands/BMad/tasks/execute-checklist.toml +6 -0
  531. package/gemini/commands/BMad/tasks/facilitate-brainstorming-session.toml +6 -0
  532. package/gemini/commands/BMad/tasks/generate-ai-frontend-prompt.toml +6 -0
  533. package/gemini/commands/BMad/tasks/index-docs.toml +6 -0
  534. package/gemini/commands/BMad/tasks/kb-mode-interaction.toml +6 -0
  535. package/gemini/commands/BMad/tasks/nfr-assess.toml +6 -0
  536. package/gemini/commands/BMad/tasks/qa-gate.toml +6 -0
  537. package/gemini/commands/BMad/tasks/review-story.toml +6 -0
  538. package/gemini/commands/BMad/tasks/risk-profile.toml +6 -0
  539. package/gemini/commands/BMad/tasks/shard-doc.toml +6 -0
  540. package/gemini/commands/BMad/tasks/test-design.toml +6 -0
  541. package/gemini/commands/BMad/tasks/trace-requirements.toml +6 -0
  542. package/gemini/commands/BMad/tasks/validate-next-story.toml +6 -0
  543. package/github/workflows/publish.yml +150 -150
  544. package/index.js +9 -9
  545. package/mcp.json +14 -14
  546. package/package.json +41 -40
  547. package/resources/images/Siesa_Logosimbolo_Azul.svg +24 -24
  548. package/resources/images/Siesa_Logosimbolo_Blanco.svg +24 -24
  549. package/resources/images/Siesa_Simbolo_Azul.svg +14 -14
  550. package/resources/images/Siesa_Simbolo_Blanco.svg +14 -14
  551. package/vscode/mcp.json +15 -15
  552. package/vscode/settings.json +12 -12
@@ -1,628 +1,628 @@
1
- # Test Quality Review - Instructions v4.0
2
-
3
- **Workflow:** `testarch-test-review`
4
- **Purpose:** Review test quality using TEA's comprehensive knowledge base and validate against best practices for maintainability, determinism, isolation, and flakiness prevention
5
- **Agent:** Test Architect (TEA)
6
- **Format:** Pure Markdown v4.0 (no XML blocks)
7
-
8
- ---
9
-
10
- ## Overview
11
-
12
- This workflow performs comprehensive test quality reviews using TEA's knowledge base of best practices. It validates tests against proven patterns for fixture architecture, network-first safeguards, data factories, determinism, isolation, and flakiness prevention. The review generates actionable feedback with quality scoring.
13
-
14
- **Key Capabilities:**
15
-
16
- - **Knowledge-Based Review**: Applies patterns from tea-index.csv fragments
17
- - **Quality Scoring**: 0-100 score based on violations and best practices
18
- - **Multi-Scope**: Review single file, directory, or entire test suite
19
- - **Pattern Detection**: Identifies flaky patterns, hard waits, race conditions
20
- - **Best Practice Validation**: BDD format, test IDs, priorities, assertions
21
- - **Actionable Feedback**: Critical issues (must fix) vs recommendations (should fix)
22
- - **Integration**: Works with story files, test-design, acceptance criteria
23
-
24
- ---
25
-
26
- ## Prerequisites
27
-
28
- **Required:**
29
-
30
- - Test file(s) to review (auto-discovered or explicitly provided)
31
- - Test framework configuration (playwright.config.ts, jest.config.js, etc.)
32
-
33
- **Recommended:**
34
-
35
- - Story file with acceptance criteria (for context)
36
- - Test design document (for priority context)
37
- - Knowledge base fragments available in tea-index.csv
38
-
39
- **Halt Conditions:**
40
-
41
- - If test file path is invalid or file doesn't exist, halt and request correction
42
- - If test_dir is empty (no tests found), halt and notify user
43
-
44
- ---
45
-
46
- ## Workflow Steps
47
-
48
- ### Step 1: Load Context and Knowledge Base
49
-
50
- **Actions:**
51
-
52
- 1. Check playwright-utils flag:
53
- - Read `{config_source}` and check `config.tea_use_playwright_utils`
54
-
55
- 2. Load relevant knowledge fragments from `{project-root}/_bmad/bmm/testarch/tea-index.csv`:
56
-
57
- **Core Patterns (Always load):**
58
- - `test-quality.md` - Definition of Done (deterministic tests, isolated with cleanup, explicit assertions, <300 lines, <1.5 min, 658 lines, 5 examples)
59
- - `data-factories.md` - Factory functions with faker: overrides, nested factories, API-first setup (498 lines, 5 examples)
60
- - `test-levels-framework.md` - E2E vs API vs Component vs Unit appropriateness with decision matrix (467 lines, 4 examples)
61
- - `selective-testing.md` - Duplicate coverage detection with tag-based, spec filter, diff-based selection (727 lines, 4 examples)
62
- - `test-healing-patterns.md` - Common failure patterns: stale selectors, race conditions, dynamic data, network errors, hard waits (648 lines, 5 examples)
63
- - `selector-resilience.md` - Selector best practices (data-testid > ARIA > text > CSS hierarchy, anti-patterns, 541 lines, 4 examples)
64
- - `timing-debugging.md` - Race condition prevention and async debugging techniques (370 lines, 3 examples)
65
-
66
- **If `config.tea_use_playwright_utils: true` (All Utilities):**
67
- - `overview.md` - Playwright utils best practices
68
- - `api-request.md` - Validate apiRequest usage patterns
69
- - `network-recorder.md` - Review HAR record/playback implementation
70
- - `auth-session.md` - Check auth token management
71
- - `intercept-network-call.md` - Validate network interception
72
- - `recurse.md` - Review polling patterns
73
- - `log.md` - Check logging best practices
74
- - `file-utils.md` - Validate file operation patterns
75
- - `burn-in.md` - Review burn-in configuration
76
- - `network-error-monitor.md` - Check error monitoring setup
77
- - `fixtures-composition.md` - Validate mergeTests usage
78
-
79
- **If `config.tea_use_playwright_utils: false`:**
80
- - `fixture-architecture.md` - Pure function → Fixture → mergeTests composition with auto-cleanup (406 lines, 5 examples)
81
- - `network-first.md` - Route intercept before navigate to prevent race conditions (489 lines, 5 examples)
82
- - `playwright-config.md` - Environment-based configuration with fail-fast validation (722 lines, 5 examples)
83
- - `component-tdd.md` - Red-Green-Refactor patterns with provider isolation (480 lines, 4 examples)
84
- - `ci-burn-in.md` - Flaky test detection with 10-iteration burn-in loop (678 lines, 4 examples)
85
-
86
- 3. Determine review scope:
87
- - **single**: Review one test file (`test_file_path` provided)
88
- - **directory**: Review all tests in directory (`test_dir` provided)
89
- - **suite**: Review entire test suite (discover all test files)
90
-
91
- 4. Auto-discover related artifacts (if `auto_discover_story: true`):
92
- - Extract test ID from filename (e.g., `1.3-E2E-001.spec.ts` → story 1.3)
93
- - Search for story file (`story-1.3.md`)
94
- - Search for test design (`test-design-story-1.3.md` or `test-design-epic-1.md`)
95
-
96
- 5. Read story file for context (if available):
97
- - Extract acceptance criteria
98
- - Extract priority classification
99
- - Extract expected test IDs
100
-
101
- **Output:** Complete knowledge base loaded, review scope determined, context gathered
102
-
103
- ---
104
-
105
- ### Step 2: Discover and Parse Test Files
106
-
107
- **Actions:**
108
-
109
- 1. **Discover test files** based on scope:
110
- - **single**: Use `test_file_path` variable
111
- - **directory**: Use `glob` to find all test files in `test_dir` (e.g., `*.spec.ts`, `*.test.js`)
112
- - **suite**: Use `glob` to find all test files recursively from project root
113
-
114
- 2. **Parse test file metadata**:
115
- - File path and name
116
- - File size (warn if >15 KB or >300 lines)
117
- - Test framework detected (Playwright, Jest, Cypress, Vitest, etc.)
118
- - Imports and dependencies
119
- - Test structure (describe/context/it blocks)
120
-
121
- 3. **Extract test structure**:
122
- - Count of describe blocks (test suites)
123
- - Count of it/test blocks (individual tests)
124
- - Test IDs (if present, e.g., `test.describe('1.3-E2E-001')`)
125
- - Priority markers (if present, e.g., `test.describe.only` for P0)
126
- - BDD structure (Given-When-Then comments or steps)
127
-
128
- 4. **Identify test patterns**:
129
- - Fixtures used
130
- - Data factories used
131
- - Network interception patterns
132
- - Assertions used (expect, assert, toHaveText, etc.)
133
- - Waits and timeouts (page.waitFor, sleep, hardcoded delays)
134
- - Conditionals (if/else, switch, ternary)
135
- - Try/catch blocks
136
- - Shared state or globals
137
-
138
- **Output:** Complete test file inventory with structure and pattern analysis
139
-
140
- ---
141
-
142
- ### Step 3: Validate Against Quality Criteria
143
-
144
- **Actions:**
145
-
146
- For each test file, validate against quality criteria (configurable via workflow variables):
147
-
148
- #### 1. BDD Format Validation (if `check_given_when_then: true`)
149
-
150
- - ✅ **PASS**: Tests use Given-When-Then structure (comments or step organization)
151
- - ⚠️ **WARN**: Tests have some structure but not explicit GWT
152
- - ❌ **FAIL**: Tests lack clear structure, hard to understand intent
153
-
154
- **Knowledge Fragment**: test-quality.md, tdd-cycles.md
155
-
156
- ---
157
-
158
- #### 2. Test ID Conventions (if `check_test_ids: true`)
159
-
160
- - ✅ **PASS**: Test IDs present and follow convention (e.g., `1.3-E2E-001`, `2.1-API-005`)
161
- - ⚠️ **WARN**: Some test IDs missing or inconsistent
162
- - ❌ **FAIL**: No test IDs, can't trace tests to requirements
163
-
164
- **Knowledge Fragment**: traceability.md, test-quality.md
165
-
166
- ---
167
-
168
- #### 3. Priority Markers (if `check_priority_markers: true`)
169
-
170
- - ✅ **PASS**: Tests classified as P0/P1/P2/P3 (via markers or test-design reference)
171
- - ⚠️ **WARN**: Some priority classifications missing
172
- - ❌ **FAIL**: No priority classification, can't determine criticality
173
-
174
- **Knowledge Fragment**: test-priorities.md, risk-governance.md
175
-
176
- ---
177
-
178
- #### 4. Hard Waits Detection (if `check_hard_waits: true`)
179
-
180
- - ✅ **PASS**: No hard waits detected (no `sleep()`, `wait(5000)`, hardcoded delays)
181
- - ⚠️ **WARN**: Some hard waits used but with justification comments
182
- - ❌ **FAIL**: Hard waits detected without justification (flakiness risk)
183
-
184
- **Patterns to detect:**
185
-
186
- - `sleep(1000)`, `setTimeout()`, `delay()`
187
- - `page.waitForTimeout(5000)` without explicit reason
188
- - `await new Promise(resolve => setTimeout(resolve, 3000))`
189
-
190
- **Knowledge Fragment**: test-quality.md, network-first.md
191
-
192
- ---
193
-
194
- #### 5. Determinism Check (if `check_determinism: true`)
195
-
196
- - ✅ **PASS**: Tests are deterministic (no conditionals, no try/catch abuse, no random values)
197
- - ⚠️ **WARN**: Some conditionals but with clear justification
198
- - ❌ **FAIL**: Tests use if/else, switch, or try/catch to control flow (flakiness risk)
199
-
200
- **Patterns to detect:**
201
-
202
- - `if (condition) { test logic }` - tests should work deterministically
203
- - `try { test } catch { fallback }` - tests shouldn't swallow errors
204
- - `Math.random()`, `Date.now()` without factory abstraction
205
-
206
- **Knowledge Fragment**: test-quality.md, data-factories.md
207
-
208
- ---
209
-
210
- #### 6. Isolation Validation (if `check_isolation: true`)
211
-
212
- - ✅ **PASS**: Tests clean up resources, no shared state, can run in any order
213
- - ⚠️ **WARN**: Some cleanup missing but isolated enough
214
- - ❌ **FAIL**: Tests share state, depend on execution order, leave resources
215
-
216
- **Patterns to check:**
217
-
218
- - afterEach/afterAll cleanup hooks present
219
- - No global variables mutated
220
- - Database/API state cleaned up after tests
221
- - Test data deleted or marked inactive
222
-
223
- **Knowledge Fragment**: test-quality.md, data-factories.md
224
-
225
- ---
226
-
227
- #### 7. Fixture Patterns (if `check_fixture_patterns: true`)
228
-
229
- - ✅ **PASS**: Uses pure function → Fixture → mergeTests pattern
230
- - ⚠️ **WARN**: Some fixtures used but not consistently
231
- - ❌ **FAIL**: No fixtures, tests repeat setup code (maintainability risk)
232
-
233
- **Patterns to check:**
234
-
235
- - Fixtures defined (e.g., `test.extend({ customFixture: async ({}, use) => { ... }})`)
236
- - Pure functions used for fixture logic
237
- - mergeTests used to combine fixtures
238
- - No beforeEach with complex setup (should be in fixtures)
239
-
240
- **Knowledge Fragment**: fixture-architecture.md
241
-
242
- ---
243
-
244
- #### 8. Data Factories (if `check_data_factories: true`)
245
-
246
- - ✅ **PASS**: Uses factory functions with overrides, API-first setup
247
- - ⚠️ **WARN**: Some factories used but also hardcoded data
248
- - ❌ **FAIL**: Hardcoded test data, magic strings/numbers (maintainability risk)
249
-
250
- **Patterns to check:**
251
-
252
- - Factory functions defined (e.g., `createUser()`, `generateInvoice()`)
253
- - Factories use faker.js or similar for realistic data
254
- - Factories accept overrides (e.g., `createUser({ email: 'custom@example.com' })`)
255
- - API-first setup (create via API, test via UI)
256
-
257
- **Knowledge Fragment**: data-factories.md
258
-
259
- ---
260
-
261
- #### 9. Network-First Pattern (if `check_network_first: true`)
262
-
263
- - ✅ **PASS**: Route interception set up BEFORE navigation (race condition prevention)
264
- - ⚠️ **WARN**: Some routes intercepted correctly, others after navigation
265
- - ❌ **FAIL**: Route interception after navigation (race condition risk)
266
-
267
- **Patterns to check:**
268
-
269
- - `page.route()` called before `page.goto()`
270
- - `page.waitForResponse()` used with explicit URL pattern
271
- - No navigation followed immediately by route setup
272
-
273
- **Knowledge Fragment**: network-first.md
274
-
275
- ---
276
-
277
- #### 10. Assertions (if `check_assertions: true`)
278
-
279
- - ✅ **PASS**: Explicit assertions present (expect, assert, toHaveText)
280
- - ⚠️ **WARN**: Some tests rely on implicit waits instead of assertions
281
- - ❌ **FAIL**: Missing assertions, tests don't verify behavior
282
-
283
- **Patterns to check:**
284
-
285
- - Each test has at least one assertion
286
- - Assertions are specific (not just truthy checks)
287
- - Assertions use framework-provided matchers (toHaveText, toBeVisible)
288
-
289
- **Knowledge Fragment**: test-quality.md
290
-
291
- ---
292
-
293
- #### 11. Test Length (if `check_test_length: true`)
294
-
295
- - ✅ **PASS**: Test file ≤200 lines (ideal), ≤300 lines (acceptable)
296
- - ⚠️ **WARN**: Test file 301-500 lines (consider splitting)
297
- - ❌ **FAIL**: Test file >500 lines (too large, maintainability risk)
298
-
299
- **Knowledge Fragment**: test-quality.md
300
-
301
- ---
302
-
303
- #### 12. Test Duration (if `check_test_duration: true`)
304
-
305
- - ✅ **PASS**: Individual tests ≤1.5 minutes (target: <30 seconds)
306
- - ⚠️ **WARN**: Some tests 1.5-3 minutes (consider optimization)
307
- - ❌ **FAIL**: Tests >3 minutes (too slow, impacts CI/CD)
308
-
309
- **Note:** Duration estimation based on complexity analysis if execution data unavailable
310
-
311
- **Knowledge Fragment**: test-quality.md, selective-testing.md
312
-
313
- ---
314
-
315
- #### 13. Flakiness Patterns (if `check_flakiness_patterns: true`)
316
-
317
- - ✅ **PASS**: No known flaky patterns detected
318
- - ⚠️ **WARN**: Some potential flaky patterns (e.g., tight timeouts, race conditions)
319
- - ❌ **FAIL**: Multiple flaky patterns detected (high flakiness risk)
320
-
321
- **Patterns to detect:**
322
-
323
- - Tight timeouts (e.g., `{ timeout: 1000 }`)
324
- - Race conditions (navigation before route interception)
325
- - Timing-dependent assertions (e.g., checking timestamps)
326
- - Retry logic in tests (hides flakiness)
327
- - Environment-dependent assumptions (hardcoded URLs, ports)
328
-
329
- **Knowledge Fragment**: test-quality.md, network-first.md, ci-burn-in.md
330
-
331
- ---
332
-
333
- ### Step 4: Calculate Quality Score
334
-
335
- **Actions:**
336
-
337
- 1. **Count violations** by severity:
338
- - **Critical (P0)**: Hard waits without justification, no assertions, race conditions, shared state
339
- - **High (P1)**: Missing test IDs, no BDD structure, hardcoded data, missing fixtures
340
- - **Medium (P2)**: Long test files (>300 lines), missing priorities, some conditionals
341
- - **Low (P3)**: Minor style issues, incomplete cleanup, verbose tests
342
-
343
- 2. **Calculate quality score** (if `quality_score_enabled: true`):
344
-
345
- ```
346
- Starting Score: 100
347
-
348
- Critical Violations: -10 points each
349
- High Violations: -5 points each
350
- Medium Violations: -2 points each
351
- Low Violations: -1 point each
352
-
353
- Bonus Points:
354
- + Excellent BDD structure: +5
355
- + Comprehensive fixtures: +5
356
- + Comprehensive data factories: +5
357
- + Network-first pattern: +5
358
- + Perfect isolation: +5
359
- + All test IDs present: +5
360
-
361
- Quality Score: max(0, min(100, Starting Score - Violations + Bonus))
362
- ```
363
-
364
- 3. **Quality Grade**:
365
- - **90-100**: Excellent (A+)
366
- - **80-89**: Good (A)
367
- - **70-79**: Acceptable (B)
368
- - **60-69**: Needs Improvement (C)
369
- - **<60**: Critical Issues (F)
370
-
371
- **Output:** Quality score calculated with violation breakdown
372
-
373
- ---
374
-
375
- ### Step 5: Generate Review Report
376
-
377
- **Actions:**
378
-
379
- 1. **Create review report** using `test-review-template.md`:
380
-
381
- **Header Section:**
382
- - Test file(s) reviewed
383
- - Review date
384
- - Review scope (single/directory/suite)
385
- - Quality score and grade
386
-
387
- **Executive Summary:**
388
- - Overall assessment (Excellent/Good/Needs Improvement/Critical)
389
- - Key strengths
390
- - Key weaknesses
391
- - Recommendation (Approve/Approve with comments/Request changes)
392
-
393
- **Quality Criteria Assessment:**
394
- - Table with all criteria evaluated
395
- - Status for each (PASS/WARN/FAIL)
396
- - Violation count per criterion
397
-
398
- **Critical Issues (Must Fix):**
399
- - Priority P0/P1 violations
400
- - Code location (file:line)
401
- - Explanation of issue
402
- - Recommended fix
403
- - Knowledge base reference
404
-
405
- **Recommendations (Should Fix):**
406
- - Priority P2/P3 violations
407
- - Code location (file:line)
408
- - Explanation of issue
409
- - Recommended improvement
410
- - Knowledge base reference
411
-
412
- **Best Practices Examples:**
413
- - Highlight good patterns found in tests
414
- - Reference knowledge base fragments
415
- - Provide examples for others to follow
416
-
417
- **Knowledge Base References:**
418
- - List all fragments consulted
419
- - Provide links to detailed guidance
420
-
421
- 2. **Generate inline comments** (if `generate_inline_comments: true`):
422
- - Add TODO comments in test files at violation locations
423
- - Format: `// TODO (TEA Review): [Issue description] - See test-review-{filename}.md`
424
- - Never modify test logic, only add comments
425
-
426
- 3. **Generate quality badge** (if `generate_quality_badge: true`):
427
- - Create badge with quality score (e.g., "Test Quality: 87/100 (A)")
428
- - Format for inclusion in README or documentation
429
-
430
- 4. **Append to story file** (if `append_to_story: true` and story file exists):
431
- - Add "Test Quality Review" section to story
432
- - Include quality score and critical issues
433
- - Link to full review report
434
-
435
- **Output:** Comprehensive review report with actionable feedback
436
-
437
- ---
438
-
439
- ### Step 6: Save Outputs and Notify
440
-
441
- **Actions:**
442
-
443
- 1. **Save review report** to `{output_file}`
444
- 2. **Save inline comments** to test files (if enabled)
445
- 3. **Save quality badge** to output folder (if enabled)
446
- 4. **Update story file** (if enabled)
447
- 5. **Generate summary message** for user:
448
- - Quality score and grade
449
- - Critical issue count
450
- - Recommendation
451
-
452
- **Output:** All review artifacts saved and user notified
453
-
454
- ---
455
-
456
- ## Quality Criteria Decision Matrix
457
-
458
- | Criterion | PASS | WARN | FAIL | Knowledge Fragment |
459
- | ------------------ | ------------------------- | -------------- | ------------------- | ----------------------- |
460
- | BDD Format | Given-When-Then present | Some structure | No structure | test-quality.md |
461
- | Test IDs | All tests have IDs | Some missing | No IDs | traceability.md |
462
- | Priority Markers | All classified | Some missing | No classification | test-priorities.md |
463
- | Hard Waits | No hard waits | Some justified | Hard waits present | test-quality.md |
464
- | Determinism | No conditionals/random | Some justified | Conditionals/random | test-quality.md |
465
- | Isolation | Clean up, no shared state | Some gaps | Shared state | test-quality.md |
466
- | Fixture Patterns | Pure fn → Fixture | Some fixtures | No fixtures | fixture-architecture.md |
467
- | Data Factories | Factory functions | Some factories | Hardcoded data | data-factories.md |
468
- | Network-First | Intercept before navigate | Some correct | Race conditions | network-first.md |
469
- | Assertions | Explicit assertions | Some implicit | Missing assertions | test-quality.md |
470
- | Test Length | ≤300 lines | 301-500 lines | >500 lines | test-quality.md |
471
- | Test Duration | ≤1.5 min | 1.5-3 min | >3 min | test-quality.md |
472
- | Flakiness Patterns | No flaky patterns | Some potential | Multiple patterns | ci-burn-in.md |
473
-
474
- ---
475
-
476
- ## Example Review Summary
477
-
478
- ````markdown
479
- # Test Quality Review: auth-login.spec.ts
480
-
481
- **Quality Score**: 78/100 (B - Acceptable)
482
- **Review Date**: 2025-10-14
483
- **Recommendation**: Approve with Comments
484
-
485
- ## Executive Summary
486
-
487
- Overall, the test demonstrates good structure and coverage of the login flow. However, there are several areas for improvement to enhance maintainability and prevent flakiness.
488
-
489
- **Strengths:**
490
-
491
- - Excellent BDD structure with clear Given-When-Then comments
492
- - Good use of test IDs (1.3-E2E-001, 1.3-E2E-002)
493
- - Comprehensive assertions on authentication state
494
-
495
- **Weaknesses:**
496
-
497
- - Hard wait detected (page.waitForTimeout(2000)) - flakiness risk
498
- - Hardcoded test data (email: 'test@example.com') - use factories instead
499
- - Missing fixture for common login setup - DRY violation
500
-
501
- **Recommendation**: Address critical issue (hard wait) before merging. Other improvements can be addressed in follow-up PR.
502
-
503
- ## Critical Issues (Must Fix)
504
-
505
- ### 1. Hard Wait Detected (Line 45)
506
-
507
- **Severity**: P0 (Critical)
508
- **Issue**: `await page.waitForTimeout(2000)` introduces flakiness
509
- **Fix**: Use explicit wait for element or network request instead
510
- **Knowledge**: See test-quality.md, network-first.md
511
-
512
- ```typescript
513
- // ❌ Bad (current)
514
- await page.waitForTimeout(2000);
515
- await expect(page.locator('[data-testid="user-menu"]')).toBeVisible();
516
-
517
- // ✅ Good (recommended)
518
- await expect(page.locator('[data-testid="user-menu"]')).toBeVisible({ timeout: 10000 });
519
- ```
520
- ````
521
-
522
- ## Recommendations (Should Fix)
523
-
524
- ### 1. Use Data Factory for Test User (Lines 23, 32, 41)
525
-
526
- **Severity**: P1 (High)
527
- **Issue**: Hardcoded email `test@example.com` - maintainability risk
528
- **Fix**: Create factory function for test users
529
- **Knowledge**: See data-factories.md
530
-
531
- ```typescript
532
- // ✅ Good (recommended)
533
- import { createTestUser } from './factories/user-factory';
534
-
535
- const testUser = createTestUser({ role: 'admin' });
536
- await loginPage.login(testUser.email, testUser.password);
537
- ```
538
-
539
- ### 2. Extract Login Setup to Fixture (Lines 18-28)
540
-
541
- **Severity**: P1 (High)
542
- **Issue**: Login setup repeated across tests - DRY violation
543
- **Fix**: Create fixture for authenticated state
544
- **Knowledge**: See fixture-architecture.md
545
-
546
- ```typescript
547
- // ✅ Good (recommended)
548
- const test = base.extend({
549
- authenticatedPage: async ({ page }, use) => {
550
- const user = createTestUser();
551
- await loginPage.login(user.email, user.password);
552
- await use(page);
553
- },
554
- });
555
-
556
- test('user can access dashboard', async ({ authenticatedPage }) => {
557
- // Test starts already logged in
558
- });
559
- ```
560
-
561
- ## Quality Score Breakdown
562
-
563
- - Starting Score: 100
564
- - Critical Violations (1 × -10): -10
565
- - High Violations (2 × -5): -10
566
- - Medium Violations (0 × -2): 0
567
- - Low Violations (1 × -1): -1
568
- - Bonus (BDD +5, Test IDs +5): +10
569
- - **Final Score**: 78/100 (B)
570
-
571
- ```
572
-
573
- ---
574
-
575
- ## Integration with Other Workflows
576
-
577
- ### Before Test Review
578
-
579
- - **atdd**: Generate acceptance tests (TEA reviews them for quality)
580
- - **automate**: Expand regression suite (TEA reviews new tests)
581
- - **dev story**: Developer writes implementation tests (TEA reviews them)
582
-
583
- ### After Test Review
584
-
585
- - **Developer**: Addresses critical issues, improves based on recommendations
586
- - **gate**: Test quality review feeds into gate decision (high-quality tests increase confidence)
587
-
588
- ### Coordinates With
589
-
590
- - **Story File**: Review links to acceptance criteria context
591
- - **Test Design**: Review validates tests align with prioritization
592
- - **Knowledge Base**: Review references fragments for detailed guidance
593
-
594
- ---
595
-
596
- ## Important Notes
597
-
598
- 1. **Non-Prescriptive**: Review provides guidance, not rigid rules
599
- 2. **Context Matters**: Some violations may be justified for specific scenarios
600
- 3. **Knowledge-Based**: All feedback grounded in proven patterns from tea-index.csv
601
- 4. **Actionable**: Every issue includes recommended fix with code examples
602
- 5. **Quality Score**: Use as indicator, not absolute measure
603
- 6. **Continuous Improvement**: Review same tests periodically as patterns evolve
604
-
605
- ---
606
-
607
- ## Troubleshooting
608
-
609
- **Problem: No test files found**
610
- - Verify test_dir path is correct
611
- - Check test file extensions match glob pattern
612
- - Ensure test files exist in expected location
613
-
614
- **Problem: Quality score seems too low/high**
615
- - Review violation counts - may need to adjust thresholds
616
- - Consider context - some projects have different standards
617
- - Focus on critical issues first, not just score
618
-
619
- **Problem: Inline comments not generated**
620
- - Check generate_inline_comments: true in variables
621
- - Verify write permissions on test files
622
- - Review append_to_file: false (separate report mode)
623
-
624
- **Problem: Knowledge fragments not loading**
625
- - Verify tea-index.csv exists in testarch/ directory
626
- - Check fragment file paths are correct
627
- - Ensure auto_load_knowledge: true in variables
628
- ```
1
+ # Test Quality Review - Instructions v4.0
2
+
3
+ **Workflow:** `testarch-test-review`
4
+ **Purpose:** Review test quality using TEA's comprehensive knowledge base and validate against best practices for maintainability, determinism, isolation, and flakiness prevention
5
+ **Agent:** Test Architect (TEA)
6
+ **Format:** Pure Markdown v4.0 (no XML blocks)
7
+
8
+ ---
9
+
10
+ ## Overview
11
+
12
+ This workflow performs comprehensive test quality reviews using TEA's knowledge base of best practices. It validates tests against proven patterns for fixture architecture, network-first safeguards, data factories, determinism, isolation, and flakiness prevention. The review generates actionable feedback with quality scoring.
13
+
14
+ **Key Capabilities:**
15
+
16
+ - **Knowledge-Based Review**: Applies patterns from tea-index.csv fragments
17
+ - **Quality Scoring**: 0-100 score based on violations and best practices
18
+ - **Multi-Scope**: Review single file, directory, or entire test suite
19
+ - **Pattern Detection**: Identifies flaky patterns, hard waits, race conditions
20
+ - **Best Practice Validation**: BDD format, test IDs, priorities, assertions
21
+ - **Actionable Feedback**: Critical issues (must fix) vs recommendations (should fix)
22
+ - **Integration**: Works with story files, test-design, acceptance criteria
23
+
24
+ ---
25
+
26
+ ## Prerequisites
27
+
28
+ **Required:**
29
+
30
+ - Test file(s) to review (auto-discovered or explicitly provided)
31
+ - Test framework configuration (playwright.config.ts, jest.config.js, etc.)
32
+
33
+ **Recommended:**
34
+
35
+ - Story file with acceptance criteria (for context)
36
+ - Test design document (for priority context)
37
+ - Knowledge base fragments available in tea-index.csv
38
+
39
+ **Halt Conditions:**
40
+
41
+ - If test file path is invalid or file doesn't exist, halt and request correction
42
+ - If test_dir is empty (no tests found), halt and notify user
43
+
44
+ ---
45
+
46
+ ## Workflow Steps
47
+
48
+ ### Step 1: Load Context and Knowledge Base
49
+
50
+ **Actions:**
51
+
52
+ 1. Check playwright-utils flag:
53
+ - Read `{config_source}` and check `config.tea_use_playwright_utils`
54
+
55
+ 2. Load relevant knowledge fragments from `{project-root}/_bmad/bmm/testarch/tea-index.csv`:
56
+
57
+ **Core Patterns (Always load):**
58
+ - `test-quality.md` - Definition of Done (deterministic tests, isolated with cleanup, explicit assertions, <300 lines, <1.5 min, 658 lines, 5 examples)
59
+ - `data-factories.md` - Factory functions with faker: overrides, nested factories, API-first setup (498 lines, 5 examples)
60
+ - `test-levels-framework.md` - E2E vs API vs Component vs Unit appropriateness with decision matrix (467 lines, 4 examples)
61
+ - `selective-testing.md` - Duplicate coverage detection with tag-based, spec filter, diff-based selection (727 lines, 4 examples)
62
+ - `test-healing-patterns.md` - Common failure patterns: stale selectors, race conditions, dynamic data, network errors, hard waits (648 lines, 5 examples)
63
+ - `selector-resilience.md` - Selector best practices (data-testid > ARIA > text > CSS hierarchy, anti-patterns, 541 lines, 4 examples)
64
+ - `timing-debugging.md` - Race condition prevention and async debugging techniques (370 lines, 3 examples)
65
+
66
+ **If `config.tea_use_playwright_utils: true` (All Utilities):**
67
+ - `overview.md` - Playwright utils best practices
68
+ - `api-request.md` - Validate apiRequest usage patterns
69
+ - `network-recorder.md` - Review HAR record/playback implementation
70
+ - `auth-session.md` - Check auth token management
71
+ - `intercept-network-call.md` - Validate network interception
72
+ - `recurse.md` - Review polling patterns
73
+ - `log.md` - Check logging best practices
74
+ - `file-utils.md` - Validate file operation patterns
75
+ - `burn-in.md` - Review burn-in configuration
76
+ - `network-error-monitor.md` - Check error monitoring setup
77
+ - `fixtures-composition.md` - Validate mergeTests usage
78
+
79
+ **If `config.tea_use_playwright_utils: false`:**
80
+ - `fixture-architecture.md` - Pure function → Fixture → mergeTests composition with auto-cleanup (406 lines, 5 examples)
81
+ - `network-first.md` - Route intercept before navigate to prevent race conditions (489 lines, 5 examples)
82
+ - `playwright-config.md` - Environment-based configuration with fail-fast validation (722 lines, 5 examples)
83
+ - `component-tdd.md` - Red-Green-Refactor patterns with provider isolation (480 lines, 4 examples)
84
+ - `ci-burn-in.md` - Flaky test detection with 10-iteration burn-in loop (678 lines, 4 examples)
85
+
86
+ 3. Determine review scope:
87
+ - **single**: Review one test file (`test_file_path` provided)
88
+ - **directory**: Review all tests in directory (`test_dir` provided)
89
+ - **suite**: Review entire test suite (discover all test files)
90
+
91
+ 4. Auto-discover related artifacts (if `auto_discover_story: true`):
92
+ - Extract test ID from filename (e.g., `1.3-E2E-001.spec.ts` → story 1.3)
93
+ - Search for story file (`story-1.3.md`)
94
+ - Search for test design (`test-design-story-1.3.md` or `test-design-epic-1.md`)
95
+
96
+ 5. Read story file for context (if available):
97
+ - Extract acceptance criteria
98
+ - Extract priority classification
99
+ - Extract expected test IDs
100
+
101
+ **Output:** Complete knowledge base loaded, review scope determined, context gathered
102
+
103
+ ---
104
+
105
+ ### Step 2: Discover and Parse Test Files
106
+
107
+ **Actions:**
108
+
109
+ 1. **Discover test files** based on scope:
110
+ - **single**: Use `test_file_path` variable
111
+ - **directory**: Use `glob` to find all test files in `test_dir` (e.g., `*.spec.ts`, `*.test.js`)
112
+ - **suite**: Use `glob` to find all test files recursively from project root
113
+
114
+ 2. **Parse test file metadata**:
115
+ - File path and name
116
+ - File size (warn if >15 KB or >300 lines)
117
+ - Test framework detected (Playwright, Jest, Cypress, Vitest, etc.)
118
+ - Imports and dependencies
119
+ - Test structure (describe/context/it blocks)
120
+
121
+ 3. **Extract test structure**:
122
+ - Count of describe blocks (test suites)
123
+ - Count of it/test blocks (individual tests)
124
+ - Test IDs (if present, e.g., `test.describe('1.3-E2E-001')`)
125
+ - Priority markers (if present, e.g., `test.describe.only` for P0)
126
+ - BDD structure (Given-When-Then comments or steps)
127
+
128
+ 4. **Identify test patterns**:
129
+ - Fixtures used
130
+ - Data factories used
131
+ - Network interception patterns
132
+ - Assertions used (expect, assert, toHaveText, etc.)
133
+ - Waits and timeouts (page.waitFor, sleep, hardcoded delays)
134
+ - Conditionals (if/else, switch, ternary)
135
+ - Try/catch blocks
136
+ - Shared state or globals
137
+
138
+ **Output:** Complete test file inventory with structure and pattern analysis
139
+
140
+ ---
141
+
142
+ ### Step 3: Validate Against Quality Criteria
143
+
144
+ **Actions:**
145
+
146
+ For each test file, validate against quality criteria (configurable via workflow variables):
147
+
148
+ #### 1. BDD Format Validation (if `check_given_when_then: true`)
149
+
150
+ - ✅ **PASS**: Tests use Given-When-Then structure (comments or step organization)
151
+ - ⚠️ **WARN**: Tests have some structure but not explicit GWT
152
+ - ❌ **FAIL**: Tests lack clear structure, hard to understand intent
153
+
154
+ **Knowledge Fragment**: test-quality.md, tdd-cycles.md
155
+
156
+ ---
157
+
158
+ #### 2. Test ID Conventions (if `check_test_ids: true`)
159
+
160
+ - ✅ **PASS**: Test IDs present and follow convention (e.g., `1.3-E2E-001`, `2.1-API-005`)
161
+ - ⚠️ **WARN**: Some test IDs missing or inconsistent
162
+ - ❌ **FAIL**: No test IDs, can't trace tests to requirements
163
+
164
+ **Knowledge Fragment**: traceability.md, test-quality.md
165
+
166
+ ---
167
+
168
+ #### 3. Priority Markers (if `check_priority_markers: true`)
169
+
170
+ - ✅ **PASS**: Tests classified as P0/P1/P2/P3 (via markers or test-design reference)
171
+ - ⚠️ **WARN**: Some priority classifications missing
172
+ - ❌ **FAIL**: No priority classification, can't determine criticality
173
+
174
+ **Knowledge Fragment**: test-priorities.md, risk-governance.md
175
+
176
+ ---
177
+
178
+ #### 4. Hard Waits Detection (if `check_hard_waits: true`)
179
+
180
+ - ✅ **PASS**: No hard waits detected (no `sleep()`, `wait(5000)`, hardcoded delays)
181
+ - ⚠️ **WARN**: Some hard waits used but with justification comments
182
+ - ❌ **FAIL**: Hard waits detected without justification (flakiness risk)
183
+
184
+ **Patterns to detect:**
185
+
186
+ - `sleep(1000)`, `setTimeout()`, `delay()`
187
+ - `page.waitForTimeout(5000)` without explicit reason
188
+ - `await new Promise(resolve => setTimeout(resolve, 3000))`
189
+
190
+ **Knowledge Fragment**: test-quality.md, network-first.md
191
+
192
+ ---
193
+
194
+ #### 5. Determinism Check (if `check_determinism: true`)
195
+
196
+ - ✅ **PASS**: Tests are deterministic (no conditionals, no try/catch abuse, no random values)
197
+ - ⚠️ **WARN**: Some conditionals but with clear justification
198
+ - ❌ **FAIL**: Tests use if/else, switch, or try/catch to control flow (flakiness risk)
199
+
200
+ **Patterns to detect:**
201
+
202
+ - `if (condition) { test logic }` - tests should work deterministically
203
+ - `try { test } catch { fallback }` - tests shouldn't swallow errors
204
+ - `Math.random()`, `Date.now()` without factory abstraction
205
+
206
+ **Knowledge Fragment**: test-quality.md, data-factories.md
207
+
208
+ ---
209
+
210
+ #### 6. Isolation Validation (if `check_isolation: true`)
211
+
212
+ - ✅ **PASS**: Tests clean up resources, no shared state, can run in any order
213
+ - ⚠️ **WARN**: Some cleanup missing but isolated enough
214
+ - ❌ **FAIL**: Tests share state, depend on execution order, leave resources
215
+
216
+ **Patterns to check:**
217
+
218
+ - afterEach/afterAll cleanup hooks present
219
+ - No global variables mutated
220
+ - Database/API state cleaned up after tests
221
+ - Test data deleted or marked inactive
222
+
223
+ **Knowledge Fragment**: test-quality.md, data-factories.md
224
+
225
+ ---
226
+
227
+ #### 7. Fixture Patterns (if `check_fixture_patterns: true`)
228
+
229
+ - ✅ **PASS**: Uses pure function → Fixture → mergeTests pattern
230
+ - ⚠️ **WARN**: Some fixtures used but not consistently
231
+ - ❌ **FAIL**: No fixtures, tests repeat setup code (maintainability risk)
232
+
233
+ **Patterns to check:**
234
+
235
+ - Fixtures defined (e.g., `test.extend({ customFixture: async ({}, use) => { ... }})`)
236
+ - Pure functions used for fixture logic
237
+ - mergeTests used to combine fixtures
238
+ - No beforeEach with complex setup (should be in fixtures)
239
+
240
+ **Knowledge Fragment**: fixture-architecture.md
241
+
242
+ ---
243
+
244
+ #### 8. Data Factories (if `check_data_factories: true`)
245
+
246
+ - ✅ **PASS**: Uses factory functions with overrides, API-first setup
247
+ - ⚠️ **WARN**: Some factories used but also hardcoded data
248
+ - ❌ **FAIL**: Hardcoded test data, magic strings/numbers (maintainability risk)
249
+
250
+ **Patterns to check:**
251
+
252
+ - Factory functions defined (e.g., `createUser()`, `generateInvoice()`)
253
+ - Factories use faker.js or similar for realistic data
254
+ - Factories accept overrides (e.g., `createUser({ email: 'custom@example.com' })`)
255
+ - API-first setup (create via API, test via UI)
256
+
257
+ **Knowledge Fragment**: data-factories.md
258
+
259
+ ---
260
+
261
+ #### 9. Network-First Pattern (if `check_network_first: true`)
262
+
263
+ - ✅ **PASS**: Route interception set up BEFORE navigation (race condition prevention)
264
+ - ⚠️ **WARN**: Some routes intercepted correctly, others after navigation
265
+ - ❌ **FAIL**: Route interception after navigation (race condition risk)
266
+
267
+ **Patterns to check:**
268
+
269
+ - `page.route()` called before `page.goto()`
270
+ - `page.waitForResponse()` used with explicit URL pattern
271
+ - No navigation followed immediately by route setup
272
+
273
+ **Knowledge Fragment**: network-first.md
274
+
275
+ ---
276
+
277
+ #### 10. Assertions (if `check_assertions: true`)
278
+
279
+ - ✅ **PASS**: Explicit assertions present (expect, assert, toHaveText)
280
+ - ⚠️ **WARN**: Some tests rely on implicit waits instead of assertions
281
+ - ❌ **FAIL**: Missing assertions, tests don't verify behavior
282
+
283
+ **Patterns to check:**
284
+
285
+ - Each test has at least one assertion
286
+ - Assertions are specific (not just truthy checks)
287
+ - Assertions use framework-provided matchers (toHaveText, toBeVisible)
288
+
289
+ **Knowledge Fragment**: test-quality.md
290
+
291
+ ---
292
+
293
+ #### 11. Test Length (if `check_test_length: true`)
294
+
295
+ - ✅ **PASS**: Test file ≤200 lines (ideal), ≤300 lines (acceptable)
296
+ - ⚠️ **WARN**: Test file 301-500 lines (consider splitting)
297
+ - ❌ **FAIL**: Test file >500 lines (too large, maintainability risk)
298
+
299
+ **Knowledge Fragment**: test-quality.md
300
+
301
+ ---
302
+
303
+ #### 12. Test Duration (if `check_test_duration: true`)
304
+
305
+ - ✅ **PASS**: Individual tests ≤1.5 minutes (target: <30 seconds)
306
+ - ⚠️ **WARN**: Some tests 1.5-3 minutes (consider optimization)
307
+ - ❌ **FAIL**: Tests >3 minutes (too slow, impacts CI/CD)
308
+
309
+ **Note:** Duration estimation based on complexity analysis if execution data unavailable
310
+
311
+ **Knowledge Fragment**: test-quality.md, selective-testing.md
312
+
313
+ ---
314
+
315
+ #### 13. Flakiness Patterns (if `check_flakiness_patterns: true`)
316
+
317
+ - ✅ **PASS**: No known flaky patterns detected
318
+ - ⚠️ **WARN**: Some potential flaky patterns (e.g., tight timeouts, race conditions)
319
+ - ❌ **FAIL**: Multiple flaky patterns detected (high flakiness risk)
320
+
321
+ **Patterns to detect:**
322
+
323
+ - Tight timeouts (e.g., `{ timeout: 1000 }`)
324
+ - Race conditions (navigation before route interception)
325
+ - Timing-dependent assertions (e.g., checking timestamps)
326
+ - Retry logic in tests (hides flakiness)
327
+ - Environment-dependent assumptions (hardcoded URLs, ports)
328
+
329
+ **Knowledge Fragment**: test-quality.md, network-first.md, ci-burn-in.md
330
+
331
+ ---
332
+
333
+ ### Step 4: Calculate Quality Score
334
+
335
+ **Actions:**
336
+
337
+ 1. **Count violations** by severity:
338
+ - **Critical (P0)**: Hard waits without justification, no assertions, race conditions, shared state
339
+ - **High (P1)**: Missing test IDs, no BDD structure, hardcoded data, missing fixtures
340
+ - **Medium (P2)**: Long test files (>300 lines), missing priorities, some conditionals
341
+ - **Low (P3)**: Minor style issues, incomplete cleanup, verbose tests
342
+
343
+ 2. **Calculate quality score** (if `quality_score_enabled: true`):
344
+
345
+ ```
346
+ Starting Score: 100
347
+
348
+ Critical Violations: -10 points each
349
+ High Violations: -5 points each
350
+ Medium Violations: -2 points each
351
+ Low Violations: -1 point each
352
+
353
+ Bonus Points:
354
+ + Excellent BDD structure: +5
355
+ + Comprehensive fixtures: +5
356
+ + Comprehensive data factories: +5
357
+ + Network-first pattern: +5
358
+ + Perfect isolation: +5
359
+ + All test IDs present: +5
360
+
361
+ Quality Score: max(0, min(100, Starting Score - Violations + Bonus))
362
+ ```
363
+
364
+ 3. **Quality Grade**:
365
+ - **90-100**: Excellent (A+)
366
+ - **80-89**: Good (A)
367
+ - **70-79**: Acceptable (B)
368
+ - **60-69**: Needs Improvement (C)
369
+ - **<60**: Critical Issues (F)
370
+
371
+ **Output:** Quality score calculated with violation breakdown
372
+
373
+ ---
374
+
375
+ ### Step 5: Generate Review Report
376
+
377
+ **Actions:**
378
+
379
+ 1. **Create review report** using `test-review-template.md`:
380
+
381
+ **Header Section:**
382
+ - Test file(s) reviewed
383
+ - Review date
384
+ - Review scope (single/directory/suite)
385
+ - Quality score and grade
386
+
387
+ **Executive Summary:**
388
+ - Overall assessment (Excellent/Good/Needs Improvement/Critical)
389
+ - Key strengths
390
+ - Key weaknesses
391
+ - Recommendation (Approve/Approve with comments/Request changes)
392
+
393
+ **Quality Criteria Assessment:**
394
+ - Table with all criteria evaluated
395
+ - Status for each (PASS/WARN/FAIL)
396
+ - Violation count per criterion
397
+
398
+ **Critical Issues (Must Fix):**
399
+ - Priority P0/P1 violations
400
+ - Code location (file:line)
401
+ - Explanation of issue
402
+ - Recommended fix
403
+ - Knowledge base reference
404
+
405
+ **Recommendations (Should Fix):**
406
+ - Priority P2/P3 violations
407
+ - Code location (file:line)
408
+ - Explanation of issue
409
+ - Recommended improvement
410
+ - Knowledge base reference
411
+
412
+ **Best Practices Examples:**
413
+ - Highlight good patterns found in tests
414
+ - Reference knowledge base fragments
415
+ - Provide examples for others to follow
416
+
417
+ **Knowledge Base References:**
418
+ - List all fragments consulted
419
+ - Provide links to detailed guidance
420
+
421
+ 2. **Generate inline comments** (if `generate_inline_comments: true`):
422
+ - Add TODO comments in test files at violation locations
423
+ - Format: `// TODO (TEA Review): [Issue description] - See test-review-{filename}.md`
424
+ - Never modify test logic, only add comments
425
+
426
+ 3. **Generate quality badge** (if `generate_quality_badge: true`):
427
+ - Create badge with quality score (e.g., "Test Quality: 87/100 (A)")
428
+ - Format for inclusion in README or documentation
429
+
430
+ 4. **Append to story file** (if `append_to_story: true` and story file exists):
431
+ - Add "Test Quality Review" section to story
432
+ - Include quality score and critical issues
433
+ - Link to full review report
434
+
435
+ **Output:** Comprehensive review report with actionable feedback
436
+
437
+ ---
438
+
439
+ ### Step 6: Save Outputs and Notify
440
+
441
+ **Actions:**
442
+
443
+ 1. **Save review report** to `{output_file}`
444
+ 2. **Save inline comments** to test files (if enabled)
445
+ 3. **Save quality badge** to output folder (if enabled)
446
+ 4. **Update story file** (if enabled)
447
+ 5. **Generate summary message** for user:
448
+ - Quality score and grade
449
+ - Critical issue count
450
+ - Recommendation
451
+
452
+ **Output:** All review artifacts saved and user notified
453
+
454
+ ---
455
+
456
+ ## Quality Criteria Decision Matrix
457
+
458
+ | Criterion | PASS | WARN | FAIL | Knowledge Fragment |
459
+ | ------------------ | ------------------------- | -------------- | ------------------- | ----------------------- |
460
+ | BDD Format | Given-When-Then present | Some structure | No structure | test-quality.md |
461
+ | Test IDs | All tests have IDs | Some missing | No IDs | traceability.md |
462
+ | Priority Markers | All classified | Some missing | No classification | test-priorities.md |
463
+ | Hard Waits | No hard waits | Some justified | Hard waits present | test-quality.md |
464
+ | Determinism | No conditionals/random | Some justified | Conditionals/random | test-quality.md |
465
+ | Isolation | Clean up, no shared state | Some gaps | Shared state | test-quality.md |
466
+ | Fixture Patterns | Pure fn → Fixture | Some fixtures | No fixtures | fixture-architecture.md |
467
+ | Data Factories | Factory functions | Some factories | Hardcoded data | data-factories.md |
468
+ | Network-First | Intercept before navigate | Some correct | Race conditions | network-first.md |
469
+ | Assertions | Explicit assertions | Some implicit | Missing assertions | test-quality.md |
470
+ | Test Length | ≤300 lines | 301-500 lines | >500 lines | test-quality.md |
471
+ | Test Duration | ≤1.5 min | 1.5-3 min | >3 min | test-quality.md |
472
+ | Flakiness Patterns | No flaky patterns | Some potential | Multiple patterns | ci-burn-in.md |
473
+
474
+ ---
475
+
476
+ ## Example Review Summary
477
+
478
+ ````markdown
479
+ # Test Quality Review: auth-login.spec.ts
480
+
481
+ **Quality Score**: 78/100 (B - Acceptable)
482
+ **Review Date**: 2025-10-14
483
+ **Recommendation**: Approve with Comments
484
+
485
+ ## Executive Summary
486
+
487
+ Overall, the test demonstrates good structure and coverage of the login flow. However, there are several areas for improvement to enhance maintainability and prevent flakiness.
488
+
489
+ **Strengths:**
490
+
491
+ - Excellent BDD structure with clear Given-When-Then comments
492
+ - Good use of test IDs (1.3-E2E-001, 1.3-E2E-002)
493
+ - Comprehensive assertions on authentication state
494
+
495
+ **Weaknesses:**
496
+
497
+ - Hard wait detected (page.waitForTimeout(2000)) - flakiness risk
498
+ - Hardcoded test data (email: 'test@example.com') - use factories instead
499
+ - Missing fixture for common login setup - DRY violation
500
+
501
+ **Recommendation**: Address critical issue (hard wait) before merging. Other improvements can be addressed in follow-up PR.
502
+
503
+ ## Critical Issues (Must Fix)
504
+
505
+ ### 1. Hard Wait Detected (Line 45)
506
+
507
+ **Severity**: P0 (Critical)
508
+ **Issue**: `await page.waitForTimeout(2000)` introduces flakiness
509
+ **Fix**: Use explicit wait for element or network request instead
510
+ **Knowledge**: See test-quality.md, network-first.md
511
+
512
+ ```typescript
513
+ // ❌ Bad (current)
514
+ await page.waitForTimeout(2000);
515
+ await expect(page.locator('[data-testid="user-menu"]')).toBeVisible();
516
+
517
+ // ✅ Good (recommended)
518
+ await expect(page.locator('[data-testid="user-menu"]')).toBeVisible({ timeout: 10000 });
519
+ ```
520
+ ````
521
+
522
+ ## Recommendations (Should Fix)
523
+
524
+ ### 1. Use Data Factory for Test User (Lines 23, 32, 41)
525
+
526
+ **Severity**: P1 (High)
527
+ **Issue**: Hardcoded email `test@example.com` - maintainability risk
528
+ **Fix**: Create factory function for test users
529
+ **Knowledge**: See data-factories.md
530
+
531
+ ```typescript
532
+ // ✅ Good (recommended)
533
+ import { createTestUser } from './factories/user-factory';
534
+
535
+ const testUser = createTestUser({ role: 'admin' });
536
+ await loginPage.login(testUser.email, testUser.password);
537
+ ```
538
+
539
+ ### 2. Extract Login Setup to Fixture (Lines 18-28)
540
+
541
+ **Severity**: P1 (High)
542
+ **Issue**: Login setup repeated across tests - DRY violation
543
+ **Fix**: Create fixture for authenticated state
544
+ **Knowledge**: See fixture-architecture.md
545
+
546
+ ```typescript
547
+ // ✅ Good (recommended)
548
+ const test = base.extend({
549
+ authenticatedPage: async ({ page }, use) => {
550
+ const user = createTestUser();
551
+ await loginPage.login(user.email, user.password);
552
+ await use(page);
553
+ },
554
+ });
555
+
556
+ test('user can access dashboard', async ({ authenticatedPage }) => {
557
+ // Test starts already logged in
558
+ });
559
+ ```
560
+
561
+ ## Quality Score Breakdown
562
+
563
+ - Starting Score: 100
564
+ - Critical Violations (1 × -10): -10
565
+ - High Violations (2 × -5): -10
566
+ - Medium Violations (0 × -2): 0
567
+ - Low Violations (1 × -1): -1
568
+ - Bonus (BDD +5, Test IDs +5): +10
569
+ - **Final Score**: 78/100 (B)
570
+
571
+ ```
572
+
573
+ ---
574
+
575
+ ## Integration with Other Workflows
576
+
577
+ ### Before Test Review
578
+
579
+ - **atdd**: Generate acceptance tests (TEA reviews them for quality)
580
+ - **automate**: Expand regression suite (TEA reviews new tests)
581
+ - **dev story**: Developer writes implementation tests (TEA reviews them)
582
+
583
+ ### After Test Review
584
+
585
+ - **Developer**: Addresses critical issues, improves based on recommendations
586
+ - **gate**: Test quality review feeds into gate decision (high-quality tests increase confidence)
587
+
588
+ ### Coordinates With
589
+
590
+ - **Story File**: Review links to acceptance criteria context
591
+ - **Test Design**: Review validates tests align with prioritization
592
+ - **Knowledge Base**: Review references fragments for detailed guidance
593
+
594
+ ---
595
+
596
+ ## Important Notes
597
+
598
+ 1. **Non-Prescriptive**: Review provides guidance, not rigid rules
599
+ 2. **Context Matters**: Some violations may be justified for specific scenarios
600
+ 3. **Knowledge-Based**: All feedback grounded in proven patterns from tea-index.csv
601
+ 4. **Actionable**: Every issue includes recommended fix with code examples
602
+ 5. **Quality Score**: Use as indicator, not absolute measure
603
+ 6. **Continuous Improvement**: Review same tests periodically as patterns evolve
604
+
605
+ ---
606
+
607
+ ## Troubleshooting
608
+
609
+ **Problem: No test files found**
610
+ - Verify test_dir path is correct
611
+ - Check test file extensions match glob pattern
612
+ - Ensure test files exist in expected location
613
+
614
+ **Problem: Quality score seems too low/high**
615
+ - Review violation counts - may need to adjust thresholds
616
+ - Consider context - some projects have different standards
617
+ - Focus on critical issues first, not just score
618
+
619
+ **Problem: Inline comments not generated**
620
+ - Check generate_inline_comments: true in variables
621
+ - Verify write permissions on test files
622
+ - Review append_to_file: false (separate report mode)
623
+
624
+ **Problem: Knowledge fragments not loading**
625
+ - Verify tea-index.csv exists in testarch/ directory
626
+ - Check fragment file paths are correct
627
+ - Ensure auto_load_knowledge: true in variables
628
+ ```