@howlil/ez-agents 2.0.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (145) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +157 -110
  3. package/README.zh-CN.md +84 -84
  4. package/agents/ez-plan-checker.md +2 -2
  5. package/agents/ez-research-synthesizer.md +1 -1
  6. package/agents/ez-ui-auditor.md +0 -2
  7. package/agents/ez-ui-checker.md +2 -4
  8. package/agents/ez-ui-researcher.md +0 -2
  9. package/agents/ez-verifier.md +1 -1
  10. package/bin/install.js +211 -211
  11. package/commands/ez/debug.md +1 -1
  12. package/commands/ez/map-codebase.md +1 -1
  13. package/commands/ez/reapply-patches.md +3 -3
  14. package/commands/ez/research-phase.md +1 -1
  15. package/{get-shit-done → ez-agents}/bin/ez-tools.cjs +1 -1
  16. package/{get-shit-done → ez-agents}/bin/lib/assistant-adapter.cjs +205 -205
  17. package/{get-shit-done → ez-agents}/bin/lib/audit-exec.cjs +150 -150
  18. package/{get-shit-done → ez-agents}/bin/lib/auth.cjs +175 -175
  19. package/{get-shit-done → ez-agents}/bin/lib/circuit-breaker.cjs +118 -118
  20. package/{get-shit-done → ez-agents}/bin/lib/commands.cjs +666 -666
  21. package/{get-shit-done → ez-agents}/bin/lib/config.cjs +183 -183
  22. package/{get-shit-done → ez-agents}/bin/lib/core.cjs +495 -495
  23. package/{get-shit-done → ez-agents}/bin/lib/file-lock.cjs +236 -236
  24. package/{get-shit-done → ez-agents}/bin/lib/frontmatter.cjs +299 -299
  25. package/{get-shit-done → ez-agents}/bin/lib/fs-utils.cjs +153 -153
  26. package/{get-shit-done → ez-agents}/bin/lib/git-utils.cjs +203 -203
  27. package/{get-shit-done → ez-agents}/bin/lib/health-check.cjs +163 -163
  28. package/{get-shit-done → ez-agents}/bin/lib/index.cjs +113 -113
  29. package/{get-shit-done → ez-agents}/bin/lib/init.cjs +710 -710
  30. package/{get-shit-done → ez-agents}/bin/lib/logger.cjs +117 -117
  31. package/{get-shit-done → ez-agents}/bin/lib/milestone.cjs +241 -241
  32. package/{get-shit-done → ez-agents}/bin/lib/model-provider.cjs +146 -146
  33. package/{get-shit-done → ez-agents}/bin/lib/phase.cjs +908 -908
  34. package/{get-shit-done → ez-agents}/bin/lib/retry.cjs +119 -119
  35. package/{get-shit-done → ez-agents}/bin/lib/roadmap.cjs +305 -305
  36. package/{get-shit-done → ez-agents}/bin/lib/safe-exec.cjs +128 -128
  37. package/{get-shit-done → ez-agents}/bin/lib/safe-path.cjs +130 -130
  38. package/{get-shit-done → ez-agents}/bin/lib/state.cjs +721 -721
  39. package/{get-shit-done → ez-agents}/bin/lib/temp-file.cjs +239 -239
  40. package/{get-shit-done → ez-agents}/bin/lib/template.cjs +222 -222
  41. package/{get-shit-done → ez-agents}/bin/lib/test-file-lock.cjs +112 -112
  42. package/{get-shit-done → ez-agents}/bin/lib/test-graceful.cjs +93 -93
  43. package/{get-shit-done → ez-agents}/bin/lib/test-logger.cjs +60 -60
  44. package/{get-shit-done → ez-agents}/bin/lib/test-safe-exec.cjs +38 -38
  45. package/{get-shit-done → ez-agents}/bin/lib/test-safe-path.cjs +33 -33
  46. package/{get-shit-done → ez-agents}/bin/lib/test-temp-file.cjs +125 -125
  47. package/{get-shit-done → ez-agents}/bin/lib/timeout-exec.cjs +62 -62
  48. package/{get-shit-done → ez-agents}/bin/lib/verify.cjs +820 -820
  49. package/{get-shit-done → ez-agents}/references/checkpoints.md +776 -776
  50. package/{get-shit-done → ez-agents}/references/questioning.md +162 -162
  51. package/{get-shit-done → ez-agents}/references/tdd.md +263 -263
  52. package/{get-shit-done → ez-agents}/templates/codebase/concerns.md +310 -310
  53. package/{get-shit-done → ez-agents}/templates/codebase/conventions.md +307 -307
  54. package/{get-shit-done → ez-agents}/templates/codebase/integrations.md +280 -280
  55. package/{get-shit-done → ez-agents}/templates/codebase/stack.md +186 -186
  56. package/{get-shit-done → ez-agents}/templates/codebase/testing.md +480 -480
  57. package/{get-shit-done → ez-agents}/templates/config.json +37 -37
  58. package/{get-shit-done → ez-agents}/templates/continue-here.md +78 -78
  59. package/{get-shit-done → ez-agents}/templates/milestone-archive.md +123 -123
  60. package/{get-shit-done → ez-agents}/templates/milestone.md +115 -115
  61. package/{get-shit-done → ez-agents}/templates/requirements.md +231 -231
  62. package/{get-shit-done → ez-agents}/templates/research-project/ARCHITECTURE.md +204 -204
  63. package/{get-shit-done → ez-agents}/templates/research-project/FEATURES.md +147 -147
  64. package/{get-shit-done → ez-agents}/templates/research-project/PITFALLS.md +200 -200
  65. package/{get-shit-done → ez-agents}/templates/research-project/STACK.md +120 -120
  66. package/{get-shit-done → ez-agents}/templates/research-project/SUMMARY.md +170 -170
  67. package/{get-shit-done → ez-agents}/templates/retrospective.md +54 -54
  68. package/{get-shit-done → ez-agents}/templates/roadmap.md +202 -202
  69. package/{get-shit-done → ez-agents}/templates/summary-minimal.md +41 -41
  70. package/{get-shit-done → ez-agents}/templates/summary-standard.md +48 -48
  71. package/{get-shit-done → ez-agents}/templates/summary.md +248 -248
  72. package/{get-shit-done → ez-agents}/templates/user-setup.md +311 -311
  73. package/{get-shit-done → ez-agents}/templates/verification-report.md +322 -322
  74. package/{get-shit-done → ez-agents}/workflows/add-phase.md +112 -112
  75. package/{get-shit-done → ez-agents}/workflows/add-tests.md +351 -351
  76. package/{get-shit-done → ez-agents}/workflows/add-todo.md +158 -158
  77. package/{get-shit-done → ez-agents}/workflows/audit-milestone.md +332 -332
  78. package/{get-shit-done → ez-agents}/workflows/autonomous.md +743 -743
  79. package/{get-shit-done → ez-agents}/workflows/check-todos.md +177 -177
  80. package/{get-shit-done → ez-agents}/workflows/cleanup.md +152 -152
  81. package/{get-shit-done → ez-agents}/workflows/complete-milestone.md +766 -766
  82. package/ez-agents/workflows/debug.md +0 -0
  83. package/{get-shit-done → ez-agents}/workflows/diagnose-issues.md +219 -219
  84. package/{get-shit-done → ez-agents}/workflows/discovery-phase.md +289 -289
  85. package/{get-shit-done → ez-agents}/workflows/discuss-phase.md +762 -762
  86. package/{get-shit-done → ez-agents}/workflows/execute-phase.md +468 -468
  87. package/{get-shit-done → ez-agents}/workflows/execute-plan.md +483 -483
  88. package/{get-shit-done → ez-agents}/workflows/health.md +159 -159
  89. package/{get-shit-done → ez-agents}/workflows/help.md +492 -492
  90. package/{get-shit-done → ez-agents}/workflows/insert-phase.md +130 -130
  91. package/{get-shit-done → ez-agents}/workflows/list-phase-assumptions.md +178 -178
  92. package/{get-shit-done → ez-agents}/workflows/map-codebase.md +316 -316
  93. package/{get-shit-done → ez-agents}/workflows/new-milestone.md +384 -384
  94. package/{get-shit-done → ez-agents}/workflows/new-project.md +1111 -1111
  95. package/{get-shit-done → ez-agents}/workflows/node-repair.md +92 -92
  96. package/{get-shit-done → ez-agents}/workflows/pause-work.md +122 -122
  97. package/{get-shit-done → ez-agents}/workflows/plan-milestone-gaps.md +274 -274
  98. package/{get-shit-done → ez-agents}/workflows/plan-phase.md +651 -651
  99. package/{get-shit-done → ez-agents}/workflows/progress.md +382 -382
  100. package/{get-shit-done → ez-agents}/workflows/quick.md +610 -610
  101. package/{get-shit-done → ez-agents}/workflows/remove-phase.md +155 -155
  102. package/{get-shit-done → ez-agents}/workflows/research-phase.md +74 -74
  103. package/{get-shit-done → ez-agents}/workflows/resume-project.md +307 -307
  104. package/{get-shit-done → ez-agents}/workflows/set-profile.md +81 -81
  105. package/{get-shit-done → ez-agents}/workflows/settings.md +242 -242
  106. package/{get-shit-done → ez-agents}/workflows/stats.md +57 -57
  107. package/{get-shit-done → ez-agents}/workflows/transition.md +544 -544
  108. package/{get-shit-done → ez-agents}/workflows/ui-phase.md +290 -290
  109. package/{get-shit-done → ez-agents}/workflows/ui-review.md +157 -157
  110. package/{get-shit-done → ez-agents}/workflows/update.md +320 -320
  111. package/{get-shit-done → ez-agents}/workflows/validate-phase.md +167 -167
  112. package/{get-shit-done → ez-agents}/workflows/verify-phase.md +243 -243
  113. package/{get-shit-done → ez-agents}/workflows/verify-work.md +5 -5
  114. package/hooks/dist/ez-check-update.js +81 -0
  115. package/hooks/dist/ez-context-monitor.js +141 -0
  116. package/hooks/dist/ez-statusline.js +115 -0
  117. package/package.json +13 -3
  118. package/scripts/build-hooks.js +43 -43
  119. package/scripts/run-tests.cjs +29 -29
  120. /package/{get-shit-done → ez-agents}/references/continuation-format.md +0 -0
  121. /package/{get-shit-done → ez-agents}/references/decimal-phase-calculation.md +0 -0
  122. /package/{get-shit-done → ez-agents}/references/git-integration.md +0 -0
  123. /package/{get-shit-done → ez-agents}/references/git-planning-commit.md +0 -0
  124. /package/{get-shit-done → ez-agents}/references/model-profile-resolution.md +0 -0
  125. /package/{get-shit-done → ez-agents}/references/model-profiles.md +0 -0
  126. /package/{get-shit-done → ez-agents}/references/phase-argument-parsing.md +0 -0
  127. /package/{get-shit-done → ez-agents}/references/planning-config.md +0 -0
  128. /package/{get-shit-done → ez-agents}/references/ui-brand.md +0 -0
  129. /package/{get-shit-done → ez-agents}/references/verification-patterns.md +0 -0
  130. /package/{get-shit-done → ez-agents}/templates/DEBUG.md +0 -0
  131. /package/{get-shit-done → ez-agents}/templates/UAT.md +0 -0
  132. /package/{get-shit-done → ez-agents}/templates/UI-SPEC.md +0 -0
  133. /package/{get-shit-done → ez-agents}/templates/VALIDATION.md +0 -0
  134. /package/{get-shit-done → ez-agents}/templates/codebase/architecture.md +0 -0
  135. /package/{get-shit-done → ez-agents}/templates/codebase/structure.md +0 -0
  136. /package/{get-shit-done → ez-agents}/templates/context.md +0 -0
  137. /package/{get-shit-done → ez-agents}/templates/copilot-instructions.md +0 -0
  138. /package/{get-shit-done → ez-agents}/templates/debug-subagent-prompt.md +0 -0
  139. /package/{get-shit-done → ez-agents}/templates/discovery.md +0 -0
  140. /package/{get-shit-done → ez-agents}/templates/phase-prompt.md +0 -0
  141. /package/{get-shit-done → ez-agents}/templates/planner-subagent-prompt.md +0 -0
  142. /package/{get-shit-done → ez-agents}/templates/project.md +0 -0
  143. /package/{get-shit-done → ez-agents}/templates/research.md +0 -0
  144. /package/{get-shit-done → ez-agents}/templates/state.md +0 -0
  145. /package/{get-shit-done → ez-agents}/templates/summary-complex.md +0 -0
@@ -1,200 +1,200 @@
1
- # Pitfalls Research Template
2
-
3
- Template for `.planning/research/PITFALLS.md` — common mistakes to avoid in the project domain.
4
-
5
- <template>
6
-
7
- ```markdown
8
- # Pitfalls Research
9
-
10
- **Domain:** [domain type]
11
- **Researched:** [date]
12
- **Confidence:** [HIGH/MEDIUM/LOW]
13
-
14
- ## Critical Pitfalls
15
-
16
- ### Pitfall 1: [Name]
17
-
18
- **What goes wrong:**
19
- [Description of the failure mode]
20
-
21
- **Why it happens:**
22
- [Root cause — why developers make this mistake]
23
-
24
- **How to avoid:**
25
- [Specific prevention strategy]
26
-
27
- **Warning signs:**
28
- [How to detect this early before it becomes a problem]
29
-
30
- **Phase to address:**
31
- [Which roadmap phase should prevent this]
32
-
33
- ---
34
-
35
- ### Pitfall 2: [Name]
36
-
37
- **What goes wrong:**
38
- [Description of the failure mode]
39
-
40
- **Why it happens:**
41
- [Root cause — why developers make this mistake]
42
-
43
- **How to avoid:**
44
- [Specific prevention strategy]
45
-
46
- **Warning signs:**
47
- [How to detect this early before it becomes a problem]
48
-
49
- **Phase to address:**
50
- [Which roadmap phase should prevent this]
51
-
52
- ---
53
-
54
- ### Pitfall 3: [Name]
55
-
56
- **What goes wrong:**
57
- [Description of the failure mode]
58
-
59
- **Why it happens:**
60
- [Root cause — why developers make this mistake]
61
-
62
- **How to avoid:**
63
- [Specific prevention strategy]
64
-
65
- **Warning signs:**
66
- [How to detect this early before it becomes a problem]
67
-
68
- **Phase to address:**
69
- [Which roadmap phase should prevent this]
70
-
71
- ---
72
-
73
- [Continue for all critical pitfalls...]
74
-
75
- ## Technical Debt Patterns
76
-
77
- Shortcuts that seem reasonable but create long-term problems.
78
-
79
- | Shortcut | Immediate Benefit | Long-term Cost | When Acceptable |
80
- |----------|-------------------|----------------|-----------------|
81
- | [shortcut] | [benefit] | [cost] | [conditions, or "never"] |
82
- | [shortcut] | [benefit] | [cost] | [conditions, or "never"] |
83
- | [shortcut] | [benefit] | [cost] | [conditions, or "never"] |
84
-
85
- ## Integration Gotchas
86
-
87
- Common mistakes when connecting to external services.
88
-
89
- | Integration | Common Mistake | Correct Approach |
90
- |-------------|----------------|------------------|
91
- | [service] | [what people do wrong] | [what to do instead] |
92
- | [service] | [what people do wrong] | [what to do instead] |
93
- | [service] | [what people do wrong] | [what to do instead] |
94
-
95
- ## Performance Traps
96
-
97
- Patterns that work at small scale but fail as usage grows.
98
-
99
- | Trap | Symptoms | Prevention | When It Breaks |
100
- |------|----------|------------|----------------|
101
- | [trap] | [how you notice] | [how to avoid] | [scale threshold] |
102
- | [trap] | [how you notice] | [how to avoid] | [scale threshold] |
103
- | [trap] | [how you notice] | [how to avoid] | [scale threshold] |
104
-
105
- ## Security Mistakes
106
-
107
- Domain-specific security issues beyond general web security.
108
-
109
- | Mistake | Risk | Prevention |
110
- |---------|------|------------|
111
- | [mistake] | [what could happen] | [how to avoid] |
112
- | [mistake] | [what could happen] | [how to avoid] |
113
- | [mistake] | [what could happen] | [how to avoid] |
114
-
115
- ## UX Pitfalls
116
-
117
- Common user experience mistakes in this domain.
118
-
119
- | Pitfall | User Impact | Better Approach |
120
- |---------|-------------|-----------------|
121
- | [pitfall] | [how users suffer] | [what to do instead] |
122
- | [pitfall] | [how users suffer] | [what to do instead] |
123
- | [pitfall] | [how users suffer] | [what to do instead] |
124
-
125
- ## "Looks Done But Isn't" Checklist
126
-
127
- Things that appear complete but are missing critical pieces.
128
-
129
- - [ ] **[Feature]:** Often missing [thing] — verify [check]
130
- - [ ] **[Feature]:** Often missing [thing] — verify [check]
131
- - [ ] **[Feature]:** Often missing [thing] — verify [check]
132
- - [ ] **[Feature]:** Often missing [thing] — verify [check]
133
-
134
- ## Recovery Strategies
135
-
136
- When pitfalls occur despite prevention, how to recover.
137
-
138
- | Pitfall | Recovery Cost | Recovery Steps |
139
- |---------|---------------|----------------|
140
- | [pitfall] | LOW/MEDIUM/HIGH | [what to do] |
141
- | [pitfall] | LOW/MEDIUM/HIGH | [what to do] |
142
- | [pitfall] | LOW/MEDIUM/HIGH | [what to do] |
143
-
144
- ## Pitfall-to-Phase Mapping
145
-
146
- How roadmap phases should address these pitfalls.
147
-
148
- | Pitfall | Prevention Phase | Verification |
149
- |---------|------------------|--------------|
150
- | [pitfall] | Phase [X] | [how to verify prevention worked] |
151
- | [pitfall] | Phase [X] | [how to verify prevention worked] |
152
- | [pitfall] | Phase [X] | [how to verify prevention worked] |
153
-
154
- ## Sources
155
-
156
- - [Post-mortems referenced]
157
- - [Community discussions]
158
- - [Official "gotchas" documentation]
159
- - [Personal experience / known issues]
160
-
161
- ---
162
- *Pitfalls research for: [domain]*
163
- *Researched: [date]*
164
- ```
165
-
166
- </template>
167
-
168
- <guidelines>
169
-
170
- **Critical Pitfalls:**
171
- - Focus on domain-specific issues, not generic mistakes
172
- - Include warning signs — early detection prevents disasters
173
- - Link to specific phases — makes pitfalls actionable
174
-
175
- **Technical Debt:**
176
- - Be realistic — some shortcuts are acceptable
177
- - Note when shortcuts are "never acceptable" vs. "only in MVP"
178
- - Include the long-term cost to inform tradeoff decisions
179
-
180
- **Performance Traps:**
181
- - Include scale thresholds ("breaks at 10k users")
182
- - Focus on what's relevant for this project's expected scale
183
- - Don't over-engineer for hypothetical scale
184
-
185
- **Security Mistakes:**
186
- - Beyond OWASP basics — domain-specific issues
187
- - Example: Community platforms have different security concerns than e-commerce
188
- - Include risk level to prioritize
189
-
190
- **"Looks Done But Isn't":**
191
- - Checklist format for verification during execution
192
- - Common in demos vs. production
193
- - Prevents "it works on my machine" issues
194
-
195
- **Pitfall-to-Phase Mapping:**
196
- - Critical for roadmap creation
197
- - Each pitfall should map to a phase that prevents it
198
- - Informs phase ordering and success criteria
199
-
200
- </guidelines>
1
+ # Pitfalls Research Template
2
+
3
+ Template for `.planning/research/PITFALLS.md` — common mistakes to avoid in the project domain.
4
+
5
+ <template>
6
+
7
+ ```markdown
8
+ # Pitfalls Research
9
+
10
+ **Domain:** [domain type]
11
+ **Researched:** [date]
12
+ **Confidence:** [HIGH/MEDIUM/LOW]
13
+
14
+ ## Critical Pitfalls
15
+
16
+ ### Pitfall 1: [Name]
17
+
18
+ **What goes wrong:**
19
+ [Description of the failure mode]
20
+
21
+ **Why it happens:**
22
+ [Root cause — why developers make this mistake]
23
+
24
+ **How to avoid:**
25
+ [Specific prevention strategy]
26
+
27
+ **Warning signs:**
28
+ [How to detect this early before it becomes a problem]
29
+
30
+ **Phase to address:**
31
+ [Which roadmap phase should prevent this]
32
+
33
+ ---
34
+
35
+ ### Pitfall 2: [Name]
36
+
37
+ **What goes wrong:**
38
+ [Description of the failure mode]
39
+
40
+ **Why it happens:**
41
+ [Root cause — why developers make this mistake]
42
+
43
+ **How to avoid:**
44
+ [Specific prevention strategy]
45
+
46
+ **Warning signs:**
47
+ [How to detect this early before it becomes a problem]
48
+
49
+ **Phase to address:**
50
+ [Which roadmap phase should prevent this]
51
+
52
+ ---
53
+
54
+ ### Pitfall 3: [Name]
55
+
56
+ **What goes wrong:**
57
+ [Description of the failure mode]
58
+
59
+ **Why it happens:**
60
+ [Root cause — why developers make this mistake]
61
+
62
+ **How to avoid:**
63
+ [Specific prevention strategy]
64
+
65
+ **Warning signs:**
66
+ [How to detect this early before it becomes a problem]
67
+
68
+ **Phase to address:**
69
+ [Which roadmap phase should prevent this]
70
+
71
+ ---
72
+
73
+ [Continue for all critical pitfalls...]
74
+
75
+ ## Technical Debt Patterns
76
+
77
+ Shortcuts that seem reasonable but create long-term problems.
78
+
79
+ | Shortcut | Immediate Benefit | Long-term Cost | When Acceptable |
80
+ |----------|-------------------|----------------|-----------------|
81
+ | [shortcut] | [benefit] | [cost] | [conditions, or "never"] |
82
+ | [shortcut] | [benefit] | [cost] | [conditions, or "never"] |
83
+ | [shortcut] | [benefit] | [cost] | [conditions, or "never"] |
84
+
85
+ ## Integration Gotchas
86
+
87
+ Common mistakes when connecting to external services.
88
+
89
+ | Integration | Common Mistake | Correct Approach |
90
+ |-------------|----------------|------------------|
91
+ | [service] | [what people do wrong] | [what to do instead] |
92
+ | [service] | [what people do wrong] | [what to do instead] |
93
+ | [service] | [what people do wrong] | [what to do instead] |
94
+
95
+ ## Performance Traps
96
+
97
+ Patterns that work at small scale but fail as usage grows.
98
+
99
+ | Trap | Symptoms | Prevention | When It Breaks |
100
+ |------|----------|------------|----------------|
101
+ | [trap] | [how you notice] | [how to avoid] | [scale threshold] |
102
+ | [trap] | [how you notice] | [how to avoid] | [scale threshold] |
103
+ | [trap] | [how you notice] | [how to avoid] | [scale threshold] |
104
+
105
+ ## Security Mistakes
106
+
107
+ Domain-specific security issues beyond general web security.
108
+
109
+ | Mistake | Risk | Prevention |
110
+ |---------|------|------------|
111
+ | [mistake] | [what could happen] | [how to avoid] |
112
+ | [mistake] | [what could happen] | [how to avoid] |
113
+ | [mistake] | [what could happen] | [how to avoid] |
114
+
115
+ ## UX Pitfalls
116
+
117
+ Common user experience mistakes in this domain.
118
+
119
+ | Pitfall | User Impact | Better Approach |
120
+ |---------|-------------|-----------------|
121
+ | [pitfall] | [how users suffer] | [what to do instead] |
122
+ | [pitfall] | [how users suffer] | [what to do instead] |
123
+ | [pitfall] | [how users suffer] | [what to do instead] |
124
+
125
+ ## "Looks Done But Isn't" Checklist
126
+
127
+ Things that appear complete but are missing critical pieces.
128
+
129
+ - [ ] **[Feature]:** Often missing [thing] — verify [check]
130
+ - [ ] **[Feature]:** Often missing [thing] — verify [check]
131
+ - [ ] **[Feature]:** Often missing [thing] — verify [check]
132
+ - [ ] **[Feature]:** Often missing [thing] — verify [check]
133
+
134
+ ## Recovery Strategies
135
+
136
+ When pitfalls occur despite prevention, how to recover.
137
+
138
+ | Pitfall | Recovery Cost | Recovery Steps |
139
+ |---------|---------------|----------------|
140
+ | [pitfall] | LOW/MEDIUM/HIGH | [what to do] |
141
+ | [pitfall] | LOW/MEDIUM/HIGH | [what to do] |
142
+ | [pitfall] | LOW/MEDIUM/HIGH | [what to do] |
143
+
144
+ ## Pitfall-to-Phase Mapping
145
+
146
+ How roadmap phases should address these pitfalls.
147
+
148
+ | Pitfall | Prevention Phase | Verification |
149
+ |---------|------------------|--------------|
150
+ | [pitfall] | Phase [X] | [how to verify prevention worked] |
151
+ | [pitfall] | Phase [X] | [how to verify prevention worked] |
152
+ | [pitfall] | Phase [X] | [how to verify prevention worked] |
153
+
154
+ ## Sources
155
+
156
+ - [Post-mortems referenced]
157
+ - [Community discussions]
158
+ - [Official "gotchas" documentation]
159
+ - [Personal experience / known issues]
160
+
161
+ ---
162
+ *Pitfalls research for: [domain]*
163
+ *Researched: [date]*
164
+ ```
165
+
166
+ </template>
167
+
168
+ <guidelines>
169
+
170
+ **Critical Pitfalls:**
171
+ - Focus on domain-specific issues, not generic mistakes
172
+ - Include warning signs — early detection prevents disasters
173
+ - Link to specific phases — makes pitfalls actionable
174
+
175
+ **Technical Debt:**
176
+ - Be realistic — some shortcuts are acceptable
177
+ - Note when shortcuts are "never acceptable" vs. "only in MVP"
178
+ - Include the long-term cost to inform tradeoff decisions
179
+
180
+ **Performance Traps:**
181
+ - Include scale thresholds ("breaks at 10k users")
182
+ - Focus on what's relevant for this project's expected scale
183
+ - Don't over-engineer for hypothetical scale
184
+
185
+ **Security Mistakes:**
186
+ - Beyond OWASP basics — domain-specific issues
187
+ - Example: Community platforms have different security concerns than e-commerce
188
+ - Include risk level to prioritize
189
+
190
+ **"Looks Done But Isn't":**
191
+ - Checklist format for verification during execution
192
+ - Common in demos vs. production
193
+ - Prevents "it works on my machine" issues
194
+
195
+ **Pitfall-to-Phase Mapping:**
196
+ - Critical for roadmap creation
197
+ - Each pitfall should map to a phase that prevents it
198
+ - Informs phase ordering and success criteria
199
+
200
+ </guidelines>
@@ -1,120 +1,120 @@
1
- # Stack Research Template
2
-
3
- Template for `.planning/research/STACK.md` — recommended technologies for the project domain.
4
-
5
- <template>
6
-
7
- ```markdown
8
- # Stack Research
9
-
10
- **Domain:** [domain type]
11
- **Researched:** [date]
12
- **Confidence:** [HIGH/MEDIUM/LOW]
13
-
14
- ## Recommended Stack
15
-
16
- ### Core Technologies
17
-
18
- | Technology | Version | Purpose | Why Recommended |
19
- |------------|---------|---------|-----------------|
20
- | [name] | [version] | [what it does] | [why experts use it for this domain] |
21
- | [name] | [version] | [what it does] | [why experts use it for this domain] |
22
- | [name] | [version] | [what it does] | [why experts use it for this domain] |
23
-
24
- ### Supporting Libraries
25
-
26
- | Library | Version | Purpose | When to Use |
27
- |---------|---------|---------|-------------|
28
- | [name] | [version] | [what it does] | [specific use case] |
29
- | [name] | [version] | [what it does] | [specific use case] |
30
- | [name] | [version] | [what it does] | [specific use case] |
31
-
32
- ### Development Tools
33
-
34
- | Tool | Purpose | Notes |
35
- |------|---------|-------|
36
- | [name] | [what it does] | [configuration tips] |
37
- | [name] | [what it does] | [configuration tips] |
38
-
39
- ## Installation
40
-
41
- ```bash
42
- # Core
43
- npm install [packages]
44
-
45
- # Supporting
46
- npm install [packages]
47
-
48
- # Dev dependencies
49
- npm install -D [packages]
50
- ```
51
-
52
- ## Alternatives Considered
53
-
54
- | Recommended | Alternative | When to Use Alternative |
55
- |-------------|-------------|-------------------------|
56
- | [our choice] | [other option] | [conditions where alternative is better] |
57
- | [our choice] | [other option] | [conditions where alternative is better] |
58
-
59
- ## What NOT to Use
60
-
61
- | Avoid | Why | Use Instead |
62
- |-------|-----|-------------|
63
- | [technology] | [specific problem] | [recommended alternative] |
64
- | [technology] | [specific problem] | [recommended alternative] |
65
-
66
- ## Stack Patterns by Variant
67
-
68
- **If [condition]:**
69
- - Use [variation]
70
- - Because [reason]
71
-
72
- **If [condition]:**
73
- - Use [variation]
74
- - Because [reason]
75
-
76
- ## Version Compatibility
77
-
78
- | Package A | Compatible With | Notes |
79
- |-----------|-----------------|-------|
80
- | [package@version] | [package@version] | [compatibility notes] |
81
-
82
- ## Sources
83
-
84
- - [Context7 library ID] — [topics fetched]
85
- - [Official docs URL] — [what was verified]
86
- - [Other source] — [confidence level]
87
-
88
- ---
89
- *Stack research for: [domain]*
90
- *Researched: [date]*
91
- ```
92
-
93
- </template>
94
-
95
- <guidelines>
96
-
97
- **Core Technologies:**
98
- - Include specific version numbers
99
- - Explain why this is the standard choice, not just what it does
100
- - Focus on technologies that affect architecture decisions
101
-
102
- **Supporting Libraries:**
103
- - Include libraries commonly needed for this domain
104
- - Note when each is needed (not all projects need all libraries)
105
-
106
- **Alternatives:**
107
- - Don't just dismiss alternatives
108
- - Explain when alternatives make sense
109
- - Helps user make informed decisions if they disagree
110
-
111
- **What NOT to Use:**
112
- - Actively warn against outdated or problematic choices
113
- - Explain the specific problem, not just "it's old"
114
- - Provide the recommended alternative
115
-
116
- **Version Compatibility:**
117
- - Note any known compatibility issues
118
- - Critical for avoiding debugging time later
119
-
120
- </guidelines>
1
+ # Stack Research Template
2
+
3
+ Template for `.planning/research/STACK.md` — recommended technologies for the project domain.
4
+
5
+ <template>
6
+
7
+ ```markdown
8
+ # Stack Research
9
+
10
+ **Domain:** [domain type]
11
+ **Researched:** [date]
12
+ **Confidence:** [HIGH/MEDIUM/LOW]
13
+
14
+ ## Recommended Stack
15
+
16
+ ### Core Technologies
17
+
18
+ | Technology | Version | Purpose | Why Recommended |
19
+ |------------|---------|---------|-----------------|
20
+ | [name] | [version] | [what it does] | [why experts use it for this domain] |
21
+ | [name] | [version] | [what it does] | [why experts use it for this domain] |
22
+ | [name] | [version] | [what it does] | [why experts use it for this domain] |
23
+
24
+ ### Supporting Libraries
25
+
26
+ | Library | Version | Purpose | When to Use |
27
+ |---------|---------|---------|-------------|
28
+ | [name] | [version] | [what it does] | [specific use case] |
29
+ | [name] | [version] | [what it does] | [specific use case] |
30
+ | [name] | [version] | [what it does] | [specific use case] |
31
+
32
+ ### Development Tools
33
+
34
+ | Tool | Purpose | Notes |
35
+ |------|---------|-------|
36
+ | [name] | [what it does] | [configuration tips] |
37
+ | [name] | [what it does] | [configuration tips] |
38
+
39
+ ## Installation
40
+
41
+ ```bash
42
+ # Core
43
+ npm install [packages]
44
+
45
+ # Supporting
46
+ npm install [packages]
47
+
48
+ # Dev dependencies
49
+ npm install -D [packages]
50
+ ```
51
+
52
+ ## Alternatives Considered
53
+
54
+ | Recommended | Alternative | When to Use Alternative |
55
+ |-------------|-------------|-------------------------|
56
+ | [our choice] | [other option] | [conditions where alternative is better] |
57
+ | [our choice] | [other option] | [conditions where alternative is better] |
58
+
59
+ ## What NOT to Use
60
+
61
+ | Avoid | Why | Use Instead |
62
+ |-------|-----|-------------|
63
+ | [technology] | [specific problem] | [recommended alternative] |
64
+ | [technology] | [specific problem] | [recommended alternative] |
65
+
66
+ ## Stack Patterns by Variant
67
+
68
+ **If [condition]:**
69
+ - Use [variation]
70
+ - Because [reason]
71
+
72
+ **If [condition]:**
73
+ - Use [variation]
74
+ - Because [reason]
75
+
76
+ ## Version Compatibility
77
+
78
+ | Package A | Compatible With | Notes |
79
+ |-----------|-----------------|-------|
80
+ | [package@version] | [package@version] | [compatibility notes] |
81
+
82
+ ## Sources
83
+
84
+ - [Context7 library ID] — [topics fetched]
85
+ - [Official docs URL] — [what was verified]
86
+ - [Other source] — [confidence level]
87
+
88
+ ---
89
+ *Stack research for: [domain]*
90
+ *Researched: [date]*
91
+ ```
92
+
93
+ </template>
94
+
95
+ <guidelines>
96
+
97
+ **Core Technologies:**
98
+ - Include specific version numbers
99
+ - Explain why this is the standard choice, not just what it does
100
+ - Focus on technologies that affect architecture decisions
101
+
102
+ **Supporting Libraries:**
103
+ - Include libraries commonly needed for this domain
104
+ - Note when each is needed (not all projects need all libraries)
105
+
106
+ **Alternatives:**
107
+ - Don't just dismiss alternatives
108
+ - Explain when alternatives make sense
109
+ - Helps user make informed decisions if they disagree
110
+
111
+ **What NOT to Use:**
112
+ - Actively warn against outdated or problematic choices
113
+ - Explain the specific problem, not just "it's old"
114
+ - Provide the recommended alternative
115
+
116
+ **Version Compatibility:**
117
+ - Note any known compatibility issues
118
+ - Critical for avoiding debugging time later
119
+
120
+ </guidelines>