fraim-framework 2.0.56 → 2.0.58

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 (224) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/bin/fraim-mcp.js +14 -0
  3. package/bin/fraim.js +23 -0
  4. package/dist/src/cli/commands/init-project.js +10 -4
  5. package/dist/src/cli/commands/mcp.js +65 -0
  6. package/dist/src/cli/setup/mcp-config-generator.js +19 -16
  7. package/dist/src/fraim/issue-tracking/ado-provider.js +304 -0
  8. package/dist/src/fraim/issue-tracking/factory.js +63 -0
  9. package/dist/src/fraim/issue-tracking/github-provider.js +200 -0
  10. package/dist/src/fraim/issue-tracking/types.js +7 -0
  11. package/dist/src/fraim/issue-tracking-config.js +83 -0
  12. package/dist/src/local-mcp-server/stdio-server.js +207 -0
  13. package/dist/src/utils/workflow-parser.js +81 -0
  14. package/package.json +17 -12
  15. package/registry/scripts/pdf-styles.css +172 -0
  16. package/registry/scripts/prep-issue.sh +46 -4
  17. package/registry/scripts/profile-server.ts +131 -130
  18. package/registry/stubs/workflows/customer-development/user-survey-dispatch.md +1 -1
  19. package/registry/stubs/workflows/customer-development/users-to-target.md +1 -1
  20. package/registry/stubs/workflows/product-building/design.md +1 -1
  21. package/registry/stubs/workflows/product-building/implement.md +1 -1
  22. package/Claude.md +0 -1
  23. package/dist/registry/ai-manager-rules/customer-development-phases/phase1-customer-profiling.md +0 -101
  24. package/dist/registry/ai-manager-rules/customer-development-phases/phase2-platform-discovery.md +0 -235
  25. package/dist/registry/ai-manager-rules/customer-development-phases/phase3-prospect-qualification.md +0 -243
  26. package/dist/registry/ai-manager-rules/customer-development-phases/phase4-inventory-compilation.md +0 -206
  27. package/dist/registry/ai-manager-rules/design-phases/design-completeness-review.md +0 -73
  28. package/dist/registry/ai-manager-rules/design-phases/design-design.md +0 -145
  29. package/dist/registry/ai-manager-rules/implement-phases/implement-code.md +0 -283
  30. package/dist/registry/ai-manager-rules/implement-phases/implement-completeness-review.md +0 -120
  31. package/dist/registry/ai-manager-rules/implement-phases/implement-regression.md +0 -173
  32. package/dist/registry/ai-manager-rules/implement-phases/implement-repro.md +0 -104
  33. package/dist/registry/ai-manager-rules/implement-phases/implement-scoping.md +0 -100
  34. package/dist/registry/ai-manager-rules/implement-phases/implement-smoke.md +0 -237
  35. package/dist/registry/ai-manager-rules/implement-phases/implement-spike.md +0 -121
  36. package/dist/registry/ai-manager-rules/implement-phases/implement-validate.md +0 -375
  37. package/dist/registry/ai-manager-rules/retrospective.md +0 -116
  38. package/dist/registry/ai-manager-rules/shared-phases/address-pr-feedback.md +0 -188
  39. package/dist/registry/ai-manager-rules/shared-phases/submit-pr.md +0 -202
  40. package/dist/registry/ai-manager-rules/shared-phases/wait-for-pr-review.md +0 -170
  41. package/dist/registry/ai-manager-rules/spec-phases/spec-competitor-analysis.md +0 -105
  42. package/dist/registry/ai-manager-rules/spec-phases/spec-completeness-review.md +0 -66
  43. package/dist/registry/ai-manager-rules/spec-phases/spec-spec.md +0 -139
  44. package/dist/registry/ai-manager-rules/user-survey-phases/phase1-survey-scoping.md +0 -60
  45. package/dist/registry/ai-manager-rules/user-survey-phases/phase2-survey-build-linkedin.md +0 -23
  46. package/dist/registry/ai-manager-rules/user-survey-phases/phase3-survey-build-reddit.md +0 -22
  47. package/dist/registry/ai-manager-rules/user-survey-phases/phase4-survey-build-x.md +0 -21
  48. package/dist/registry/ai-manager-rules/user-survey-phases/phase5-survey-build-facebook.md +0 -19
  49. package/dist/registry/ai-manager-rules/user-survey-phases/phase6-survey-build-custom.md +0 -15
  50. package/dist/registry/ai-manager-rules/user-survey-phases/phase7-survey-dispatch.md +0 -45
  51. package/dist/registry/providers/ado.json +0 -19
  52. package/dist/registry/providers/github.json +0 -19
  53. package/dist/registry/scripts/cleanup-branch.js +0 -287
  54. package/dist/registry/scripts/evaluate-code-quality.js +0 -66
  55. package/dist/registry/scripts/exec-with-timeout.js +0 -142
  56. package/dist/registry/scripts/generate-engagement-emails.js +0 -705
  57. package/dist/registry/scripts/newsletter-helpers.js +0 -671
  58. package/dist/registry/scripts/profile-server.js +0 -388
  59. package/dist/registry/scripts/run-thank-you-workflow.js +0 -92
  60. package/dist/registry/scripts/send-newsletter-simple.js +0 -85
  61. package/dist/registry/scripts/send-thank-you-emails.js +0 -54
  62. package/dist/registry/scripts/validate-openapi-limits.js +0 -311
  63. package/dist/registry/scripts/validate-test-coverage.js +0 -262
  64. package/dist/registry/scripts/verify-test-coverage.js +0 -66
  65. package/dist/registry/templates/bootstrap/ARCHITECTURE-TEMPLATE.md +0 -53
  66. package/dist/registry/templates/bootstrap/CODE-QUALITY-REPORT-TEMPLATE.md +0 -37
  67. package/dist/registry/templates/bootstrap/TEST-COVERAGE-REPORT-TEMPLATE.md +0 -35
  68. package/dist/registry/templates/business-development/IDEATION-REPORT-TEMPLATE.md +0 -29
  69. package/dist/registry/templates/business-development/PRICING-STRATEGY-TEMPLATE.md +0 -126
  70. package/dist/registry/templates/customer-development/customer-interview-template.md +0 -99
  71. package/dist/registry/templates/customer-development/customer-persona-template.md +0 -69
  72. package/dist/registry/templates/customer-development/follow-up-email-templates.md +0 -132
  73. package/dist/registry/templates/customer-development/insight-analysis-template.md +0 -74
  74. package/dist/registry/templates/customer-development/prospect-inventory-template.csv +0 -3
  75. package/dist/registry/templates/customer-development/search-strategy-template.md +0 -123
  76. package/dist/registry/templates/customer-development/strategic-recommendations-template.md +0 -53
  77. package/dist/registry/templates/customer-development/thank-you-email-template.html +0 -124
  78. package/dist/registry/templates/customer-development/thank-you-note-template.md +0 -16
  79. package/dist/registry/templates/customer-development/triage-log-template.md +0 -278
  80. package/dist/registry/templates/customer-development/weekly-newsletter-template.html +0 -204
  81. package/dist/registry/templates/evidence/Design-Evidence.md +0 -30
  82. package/dist/registry/templates/evidence/Implementation-BugEvidence.md +0 -94
  83. package/dist/registry/templates/evidence/Implementation-FeatureEvidence.md +0 -129
  84. package/dist/registry/templates/evidence/Spec-Evidence.md +0 -19
  85. package/dist/registry/templates/help/HelpNeeded.md +0 -14
  86. package/dist/registry/templates/legal/NDA-TEMPLATE.md +0 -170
  87. package/dist/registry/templates/legal/PATENT-TEMPLATE.md +0 -372
  88. package/dist/registry/templates/legal/TRADEMARK-TEMPLATE.md +0 -339
  89. package/dist/registry/templates/legal/contract-review-checklist.md +0 -193
  90. package/dist/registry/templates/legal/review-report-template.md +0 -198
  91. package/dist/registry/templates/legal/saas-terms-template.md +0 -174
  92. package/dist/registry/templates/legal/sow-template.md +0 -117
  93. package/dist/registry/templates/legal/template-variables.md +0 -131
  94. package/dist/registry/templates/marketing/DOMAIN-REGISTRATION-TEMPLATE.md +0 -194
  95. package/dist/registry/templates/marketing/HBR-ARTICLE-TEMPLATE.md +0 -66
  96. package/dist/registry/templates/marketing/STORYTELLING-TEMPLATE.md +0 -130
  97. package/dist/registry/templates/marketing/WEBSITE-TEMPLATE.md +0 -262
  98. package/dist/registry/templates/marketing/github-pages-workflow.yml +0 -64
  99. package/dist/registry/templates/replicate/implementation-checklist.md +0 -39
  100. package/dist/registry/templates/replicate/use-cases-template.md +0 -88
  101. package/dist/registry/templates/retrospective/RETROSPECTIVE-TEMPLATE.md +0 -55
  102. package/dist/registry/templates/specs/BUGSPEC-TEMPLATE.md +0 -37
  103. package/dist/registry/templates/specs/FEATURESPEC-TEMPLATE.md +0 -66
  104. package/dist/registry/templates/specs/TECHSPEC-TEMPLATE.md +0 -39
  105. package/dist/registry/workflows/bootstrap/create-architecture.md +0 -38
  106. package/dist/registry/workflows/bootstrap/detect-broken-windows.md +0 -300
  107. package/dist/registry/workflows/bootstrap/evaluate-code-quality.md +0 -35
  108. package/dist/registry/workflows/bootstrap/verify-test-coverage.md +0 -36
  109. package/dist/registry/workflows/brainstorming/blue-sky-brainstorming.md +0 -211
  110. package/dist/registry/workflows/brainstorming/codebase-brainstorming.md +0 -165
  111. package/dist/registry/workflows/business-development/create-business-plan.md +0 -737
  112. package/dist/registry/workflows/business-development/ideate-business-opportunity.md +0 -55
  113. package/dist/registry/workflows/business-development/price-product.md +0 -325
  114. package/dist/registry/workflows/compliance/detect-compliance-requirements.md +0 -78
  115. package/dist/registry/workflows/compliance/generate-audit-evidence.md +0 -75
  116. package/dist/registry/workflows/compliance/soc2-evidence-generator.md +0 -332
  117. package/dist/registry/workflows/customer-development/insight-analysis.md +0 -156
  118. package/dist/registry/workflows/customer-development/insight-triage.md +0 -938
  119. package/dist/registry/workflows/customer-development/interview-preparation.md +0 -452
  120. package/dist/registry/workflows/customer-development/linkedin-outreach.md +0 -593
  121. package/dist/registry/workflows/customer-development/strategic-brainstorming.md +0 -146
  122. package/dist/registry/workflows/customer-development/thank-customers.md +0 -203
  123. package/dist/registry/workflows/customer-development/user-survey-dispatch.md +0 -60
  124. package/dist/registry/workflows/customer-development/users-to-target.md +0 -112
  125. package/dist/registry/workflows/customer-development/weekly-newsletter.md +0 -366
  126. package/dist/registry/workflows/deploy/cloud-deployment.md +0 -310
  127. package/dist/registry/workflows/improve-fraim/contribute.md +0 -32
  128. package/dist/registry/workflows/improve-fraim/file-issue.md +0 -32
  129. package/dist/registry/workflows/learning/build-skillset.md +0 -212
  130. package/dist/registry/workflows/learning/synthesize-learnings.md +0 -284
  131. package/dist/registry/workflows/legal/contract-review-analysis.md +0 -382
  132. package/dist/registry/workflows/legal/nda.md +0 -69
  133. package/dist/registry/workflows/legal/patent-filing.md +0 -76
  134. package/dist/registry/workflows/legal/saas-contract-development.md +0 -213
  135. package/dist/registry/workflows/legal/trademark-filing.md +0 -77
  136. package/dist/registry/workflows/marketing/content-creation.md +0 -37
  137. package/dist/registry/workflows/marketing/convert-to-pdf.md +0 -235
  138. package/dist/registry/workflows/marketing/create-modern-website.md +0 -456
  139. package/dist/registry/workflows/marketing/domain-registration.md +0 -323
  140. package/dist/registry/workflows/marketing/hbr-article.md +0 -73
  141. package/dist/registry/workflows/marketing/launch-checklist.md +0 -37
  142. package/dist/registry/workflows/marketing/marketing-strategy.md +0 -45
  143. package/dist/registry/workflows/marketing/storytelling.md +0 -65
  144. package/dist/registry/workflows/performance/analyze-performance.md +0 -65
  145. package/dist/registry/workflows/product-building/design.md +0 -103
  146. package/dist/registry/workflows/product-building/implement.md +0 -74
  147. package/dist/registry/workflows/product-building/iterate-on-pr-comments.md +0 -70
  148. package/dist/registry/workflows/product-building/prep-issue.md +0 -41
  149. package/dist/registry/workflows/product-building/prototype.md +0 -65
  150. package/dist/registry/workflows/product-building/resolve.md +0 -168
  151. package/dist/registry/workflows/product-building/retrospect.md +0 -86
  152. package/dist/registry/workflows/product-building/spec.md +0 -181
  153. package/dist/registry/workflows/product-building/test.md +0 -125
  154. package/dist/registry/workflows/productivity-report/productivity-report.md +0 -263
  155. package/dist/registry/workflows/quality-assurance/browser-validation.md +0 -221
  156. package/dist/registry/workflows/quality-assurance/iterative-improvement-cycle.md +0 -562
  157. package/dist/registry/workflows/replicate/replicate-discovery.md +0 -336
  158. package/dist/registry/workflows/replicate/replicate-to-issues.md +0 -324
  159. package/dist/registry/workflows/reviewer/review-implementation-vs-design-spec.md +0 -638
  160. package/dist/registry/workflows/reviewer/review-implementation-vs-feature-spec.md +0 -675
  161. package/dist/registry/workflows/startup-credits/aws-activate-application.md +0 -535
  162. package/dist/registry/workflows/startup-credits/google-cloud-application.md +0 -647
  163. package/dist/registry/workflows/startup-credits/microsoft-azure-application.md +0 -538
  164. package/dist/scripts/build-stub-registry.js +0 -108
  165. package/dist/src/ai-manager/ai-manager.js +0 -480
  166. package/dist/src/ai-manager/phase-flow.js +0 -357
  167. package/dist/src/ai-manager/types.js +0 -5
  168. package/dist/src/fraim-mcp-server.js +0 -1885
  169. package/dist/tests/debug-tools.js +0 -80
  170. package/dist/tests/shared-server-utils.js +0 -57
  171. package/dist/tests/test-add-ide.js +0 -283
  172. package/dist/tests/test-ai-coach-edge-cases.js +0 -420
  173. package/dist/tests/test-ai-coach-mcp-integration.js +0 -450
  174. package/dist/tests/test-ai-coach-performance.js +0 -328
  175. package/dist/tests/test-ai-coach-phase-content.js +0 -264
  176. package/dist/tests/test-ai-coach-workflows.js +0 -514
  177. package/dist/tests/test-cli.js +0 -228
  178. package/dist/tests/test-client-scripts-validation.js +0 -167
  179. package/dist/tests/test-complete-setup-flow.js +0 -110
  180. package/dist/tests/test-config-system.js +0 -279
  181. package/dist/tests/test-debug-session.js +0 -134
  182. package/dist/tests/test-end-to-end-hybrid-validation.js +0 -328
  183. package/dist/tests/test-enhanced-session-init.js +0 -188
  184. package/dist/tests/test-first-run-journey.js +0 -368
  185. package/dist/tests/test-fraim-issues.js +0 -59
  186. package/dist/tests/test-genericization.js +0 -44
  187. package/dist/tests/test-hybrid-script-execution.js +0 -340
  188. package/dist/tests/test-ide-detector.js +0 -46
  189. package/dist/tests/test-improved-setup.js +0 -121
  190. package/dist/tests/test-mcp-config-generator.js +0 -99
  191. package/dist/tests/test-mcp-connection.js +0 -107
  192. package/dist/tests/test-mcp-issue-integration.js +0 -156
  193. package/dist/tests/test-mcp-lifecycle-methods.js +0 -240
  194. package/dist/tests/test-mcp-shared-server.js +0 -308
  195. package/dist/tests/test-mcp-template-processing.js +0 -160
  196. package/dist/tests/test-modular-issue-tracking.js +0 -165
  197. package/dist/tests/test-node-compatibility.js +0 -95
  198. package/dist/tests/test-npm-install.js +0 -68
  199. package/dist/tests/test-package-size.js +0 -108
  200. package/dist/tests/test-pr-review-workflow.js +0 -307
  201. package/dist/tests/test-prep-issue.js +0 -129
  202. package/dist/tests/test-productivity-integration.js +0 -157
  203. package/dist/tests/test-script-location-independence.js +0 -198
  204. package/dist/tests/test-script-sync.js +0 -557
  205. package/dist/tests/test-server-utils.js +0 -32
  206. package/dist/tests/test-session-rehydration.js +0 -148
  207. package/dist/tests/test-setup-integration.js +0 -98
  208. package/dist/tests/test-setup-scenarios.js +0 -322
  209. package/dist/tests/test-standalone.js +0 -143
  210. package/dist/tests/test-stub-registry.js +0 -136
  211. package/dist/tests/test-sync-stubs.js +0 -143
  212. package/dist/tests/test-sync-version-update.js +0 -93
  213. package/dist/tests/test-telemetry.js +0 -193
  214. package/dist/tests/test-token-validator.js +0 -30
  215. package/dist/tests/test-user-journey.js +0 -236
  216. package/dist/tests/test-users-to-target-workflow.js +0 -253
  217. package/dist/tests/test-utils.js +0 -109
  218. package/dist/tests/test-wizard.js +0 -71
  219. package/dist/tests/test-workflow-discovery.js +0 -242
  220. package/labels.json +0 -52
  221. package/registry/agent-guardrails.md +0 -63
  222. package/registry/fraim.md +0 -48
  223. package/setup.js +0 -171
  224. package/tsconfig.json +0 -23
@@ -1,100 +0,0 @@
1
- # Phase: Implement-Scoping
2
-
3
- ## INTENT
4
- To understand the issue requirements and determine whether it's a bug fix or feature implementation.
5
-
6
- ## OUTCOME
7
- Clear understanding of:
8
- - Issue type (bug or feature)
9
- - All requirements and acceptance criteria
10
- - Ready to proceed to next phase (repro for bugs, spike for features)
11
-
12
- ## PRINCIPLES
13
- - **Thorough Understanding**: Read all linked documents and context
14
- - **Clear Classification**: Accurately determine bug vs feature
15
- - **Question Early**: Escalate if requirements are unclear
16
-
17
- ## RULES FOR THIS PHASE
18
-
19
- ### Success Criteria
20
- Read `registry/rules/agent-success-criteria.md` via `get_fraim_file` for the complete 5-criteria success framework. Focus especially on **Integrity** (truthfulness in reporting) and **Independence** (smart decision making).
21
-
22
- ### Simplicity Principles
23
- Read `registry/rules/simplicity.md` via `get_fraim_file` for complete guidelines. Key principles for scoping:
24
- - **Focus on the assigned issue only** - don't scope other issues
25
- - **Don't over-think it** - understand the specific need being addressed
26
-
27
- ### Architecture Compliance
28
- Read `.fraim/config.json` for the architecture document path (`customizations.architectureDoc`), then read the local architecture document to understand the full architecture guidelines. Understanding the architecture helps with proper scoping.
29
-
30
- ## WORKFLOW
31
-
32
- ### Step 1: Get Repository Context and Issue Details
33
-
34
- **GitHub Repository Context**: Before using GitHub MCP tools, read the local `.fraim/config.json` file to get the repository context:
35
- - Use `git.repoOwner` for the GitHub repository owner
36
- - Use `git.repoName` for the GitHub repository name
37
- - These values are required for GitHub MCP API calls (owner/repo parameters)
38
-
39
- **Read Issue Details**: Use GitHub MCP tools to get the complete issue information:
40
- - Read the full issue description in GitHub (use MCP where available)
41
- - Note the issue title, labels, and any linked documents
42
- - Identify if there's a spec, RFC, or design document
43
-
44
- ### Step 2: Review Linked Documents
45
- - If spec/RFC exists: Read it thoroughly
46
- - If design document exists: Review the technical approach
47
- - Note all acceptance criteria and requirements
48
-
49
- ### Step 3: Determine Issue Type
50
- **Bug indicators:**
51
- - Issue describes broken/incorrect behavior
52
- - References a regression or failure
53
- - Has reproduction steps
54
- - Reports unexpected behavior
55
-
56
- **Feature indicators:**
57
- - Issue describes new functionality
58
- - Adds capabilities that don't exist
59
- - Enhances existing features
60
- - Has acceptance criteria for new behavior
61
-
62
- ### Step 4: Understand Requirements
63
- - List all acceptance criteria
64
- - Identify edge cases mentioned
65
- - Note any constraints or limitations
66
- - Understand success criteria
67
-
68
- ### Step 5: Identify Uncertainties
69
- If anything is unclear:
70
- - **DO NOT** make assumptions
71
- - **DO NOT** hypothesize requirements
72
- - **ESCALATE** to user with specific questions
73
- - Wait for clarification before proceeding
74
-
75
- ## VALIDATION
76
-
77
- ### Phase Complete When:
78
- - ✅ Issue type determined (bug or feature)
79
- - ✅ All requirements understood
80
- - ✅ No blocking uncertainties remain
81
- - ✅ Ready to proceed to next phase
82
-
83
- ### Report Back:
84
- When you complete scoping, call:
85
-
86
- ```javascript
87
- seekCoachingOnNextStep({
88
- workflowType: "implement",
89
- issueNumber: "{issue_number}",
90
- currentPhase: "implement-scoping",
91
- status: "complete",
92
- findings: {
93
- issueType: "bug", // or "feature"
94
- requirements: "Brief summary of what you understood",
95
- uncertainties: [] // List any unclear aspects, or empty array if none
96
- }
97
- })
98
- ```
99
-
100
- The AI Coach will provide instructions for your next phase based on the issue type you determined.
@@ -1,237 +0,0 @@
1
- # Phase: Implement-Smoke
2
-
3
- ## INTENT
4
- To run technical health checks ensuring the system is stable: build passes, all tests pass, git status is clean, and core functionality hasn't been broken by the implementation.
5
-
6
- ## OUTCOME
7
- All technical checks pass, confirming:
8
- - Build compiles successfully
9
- - All tests pass (100% success rate)
10
- - Git status is clean
11
- - Core system functionality intact
12
- - No regressions in critical paths
13
-
14
- **Note**: This phase focuses purely on technical health checks. Manual validation and functional testing are handled in the implement-validate phase.
15
-
16
- ## PRINCIPLES
17
- - **Zero Tolerance**: All checks must pass
18
- - **Technical Focus**: Automated verification only
19
- - **Fix Immediately**: If any check fails, return to implement phase
20
- - **Fast Feedback**: Quick automated verification
21
-
22
- ## 📋 MANDATORY TECHNICAL CHECKS
23
-
24
- ### Step 0: Read Project Validation Commands 📖
25
-
26
- **FIRST**: Check your project's custom commands:
27
-
28
- ```bash
29
- # Check for custom build command
30
- cat .fraim/config.json | grep -A 3 "buildCommand"
31
-
32
- # Check for custom smoke test command
33
- cat .fraim/config.json | grep -A 3 "smokeTestCommand"
34
- ```
35
-
36
- **Use the configured commands if they exist, otherwise use the defaults shown below.**
37
-
38
- ### Step 1: Build Compilation Check ✅
39
-
40
- **Requirements**:
41
- - TypeScript compiles without errors
42
- - Build process completes successfully
43
- - No type errors or warnings
44
-
45
- **Commands to Run** (use customizations.validation.buildCommand from config if available):
46
- ```bash
47
- # Use project-specific build command from .fraim/config.json if available:
48
- # - Look for customizations.validation.buildCommand
49
- # - Use that command if available, otherwise default to:
50
- npm run build
51
- ```
52
-
53
- **What to Look For**:
54
- - Exit code 0 (success) for all commands
55
- - No error messages in output
56
- - Clean compilation without warnings
57
-
58
- ### Step 2: Complete Test Suite ✅
59
-
60
- **Requirements**:
61
- - ALL existing tests pass (100% success rate) - not just tests you created
62
- - No timeouts or hanging tests
63
- - Comprehensive test coverage validation
64
-
65
- **CRITICAL**: You must run the COMPLETE test suite, including all existing tests, smoke tests, and any tests you created. Do not run only the tests you wrote.
66
-
67
- **Commands to Run** (use customizations.validation.smokeTestCommand from config if available):
68
- ```bash
69
- # Run the comprehensive test suite (use customizations.validation.smokeTestCommand if available)
70
- npm test
71
- ```
72
-
73
- **What to Look For**:
74
- - "All tests passed" or similar success message
75
- - No "FAILED" or "ERROR" in output
76
- - Test count should include existing tests + any new tests you added
77
- - No timeout messages
78
- - Verify that existing functionality tests are included in the run
79
-
80
- **Example Expected Output**:
81
- ```
82
- ✅ Running 45 tests (including existing + new tests)
83
- ✅ All tests passed
84
- ✅ Test suite completed successfully
85
- ```
86
-
87
- ### Step 3: Git Status Check ✅
88
-
89
- **Requirements**:
90
- - Git status is clean
91
- - Only intended changes present
92
- - No untracked files (except evidence docs)
93
-
94
- **Commands to Run**:
95
- ```bash
96
- # Check git status
97
- git status
98
-
99
- # Check recent commits
100
- git log --oneline -3
101
- ```
102
-
103
- **What to Look For**:
104
- - Only intended files are modified
105
- - No accidentally modified files
106
- - Clean working directory
107
- - Meaningful commit messages
108
-
109
- ### Step 4: Code Quality Verification ✅
110
-
111
- **Requirements**:
112
- - No type bypassing
113
- - No debugging code remains
114
- - No task placeholder comments in core functionality
115
-
116
- **Commands to Run**:
117
- ```bash
118
- # Check for type bypassing
119
- grep -r "as any" src/ || echo "✅ No type bypassing found"
120
-
121
- # Look for debugging code
122
- grep -r "console.log" src/ | grep -v "logger" | grep -v "// OK" || echo "✅ No debug logs found"
123
-
124
- # Check for task placeholder comments
125
- grep -r "task-placeholder" src/ || echo "✅ No task placeholders found"
126
- ```
127
-
128
- **What to Look For**:
129
- - Zero instances of "as any" (or only justified ones with comments)
130
- - No console.log statements (except intentional logging)
131
- - No task placeholder comments in critical code
132
-
133
- ## 🛠️ TECHNICAL COMMANDS REFERENCE
134
-
135
- ### Project-Specific Commands (Read from .fraim/config.json)
136
- ```bash
137
- # Check your project's custom validation commands:
138
- cat .fraim/config.json | grep -A 5 "validation"
139
- ```
140
-
141
- ### Quick Health Check
142
- ```bash
143
- # One-liner using project defaults (customize based on your config)
144
- npm run build && npm test && git status
145
- ```
146
-
147
- ## VALIDATION
148
-
149
- ### Phase Complete When:
150
- - ✅ Build succeeds without errors
151
- - ✅ All tests pass (100% success rate)
152
- - ✅ Git status clean (only intended changes)
153
- - ✅ No "as any" type bypassing
154
- - ✅ No debugging code remains
155
- - ✅ No task placeholder comments in core functionality
156
- - ✅ All technical checks documented
157
-
158
- ### Phase Incomplete If:
159
- - ❌ Build fails
160
- - ❌ ANY test fails
161
- - ❌ Git status shows unintended changes
162
- - ❌ Code quality issues found
163
-
164
- **If ANY check fails, return to implement-code phase immediately.**
165
-
166
- ## RULES FOR THIS PHASE
167
-
168
- ### Technical Standards
169
- - Read `.fraim/config.json` for the architecture document path (`customizations.architectureDoc`), then read the local architecture document to understand the full technical standards
170
- - **Config Commands**: Always check `.fraim/config.json` first for `customizations.validation.buildCommand` and `customizations.validation.smokeTestCommand`, use those if available, otherwise use defaults
171
- - Use Successful Debugging Patterns from `rules/successful-debugging-patterns.md` via `get_fraim_file`
172
- - When using git commands directly (if MCP tools unavailable), read `rules/git-safe-commands.md` via `get_fraim_file`
173
-
174
- ### Failure Handling
175
- - **If ANY technical check fails**: Return to implement-code phase
176
- - **Do not proceed to regression phase** if smoke tests fail
177
- - Fix the implementation first, then re-run smoke tests
178
-
179
- ## SCRIPTS
180
-
181
- **Run all technical checks:**
182
- ```bash
183
- npm run build && npm test && git status
184
- ```
185
-
186
- **Run smoke tests specifically:**
187
- ```bash
188
- # Use project-specific command from .fraim/config.json if available
189
- # Check: cat .fraim/config.json | grep "smokeTestCommand"
190
- # Use configured command or default to:
191
- npm run test-smoke-ci
192
- ```
193
-
194
- ### Report Back:
195
- When you complete this phase, call:
196
-
197
- ```javascript
198
- seekCoachingOnNextStep({
199
- workflowType: "implement",
200
- issueNumber: "{issue_number}",
201
- currentPhase: "implement-smoke",
202
- status: "complete",
203
- findings: {
204
- issueType: "bug" // or "feature" - Required for phase validation
205
- },
206
- evidence: {
207
- buildPassed: "YES", // Did `npm run build` succeed?
208
- allTestsPassed: "YES", // Did `npm test` show 100% pass rate?
209
- gitStatusClean: "YES", // Does `git status` show only intended changes?
210
- noTypeBypass: "YES", // Did `grep -r "as any" src/` find zero instances?
211
- noDebugCode: "YES", // Did you remove console.log statements?
212
- registryValid: "YES", // Did `npm run validate:registry` pass?
213
- commandsRun: "npm run build && npm test && git status",
214
- summary: "All technical checks passed. Build succeeds, all tests pass, git status clean."
215
- }
216
- })
217
- ```
218
-
219
- If any technical check fails:
220
- ```javascript
221
- seekCoachingOnNextStep({
222
- workflowType: "implement",
223
- issueNumber: "{issue_number}",
224
- currentPhase: "implement-smoke",
225
- status: "incomplete",
226
- findings: {
227
- issueType: "bug" // or "feature" - Required for phase validation
228
- },
229
- evidence: {
230
- buildPassed: "NO", // Specify what failed
231
- allTestsPassed: "NO", // Be specific about failures
232
- issues: ["Build failed with TypeScript errors", "3 tests failing"],
233
- commandsRun: "npm run build && npm test",
234
- nextAction: "Returning to implement phase to fix technical issues"
235
- }
236
- })
237
- ```
@@ -1,121 +0,0 @@
1
- # Phase: Implement-Spike (Features Only)
2
-
3
- ## INTENT
4
- To build a proof-of-concept that validates the technical approach, tests uncertain or risky aspects, and confirms the design is viable before full implementation.
5
-
6
- ## OUTCOME
7
- A working POC that:
8
- - Validates key technical assumptions
9
- - Tests risky or uncertain aspects
10
- - Gets user approval
11
- - Informs any necessary design updates
12
-
13
- ## PRINCIPLES
14
- - **Spike-First Development**: Follow the spike-first rule for unfamiliar technology
15
- - **Risk Reduction**: Focus on highest-risk or most uncertain aspects
16
- - **Quick Validation**: Build minimal POC, not production code
17
- - **User Approval**: Get explicit approval before proceeding
18
- - **Design Updates**: Update design doc with findings
19
-
20
- ## WORKFLOW
21
-
22
- ### Step 1: Review Design Document
23
- - Read the technical design/RFC thoroughly
24
- - Identify technical assumptions
25
- - Note any unfamiliar technologies or patterns
26
- - List risky or uncertain aspects
27
-
28
- ### Step 2: Identify Spike Scope
29
- **Focus on:**
30
- - Unfamiliar technology or libraries
31
- - Integration points with external systems
32
- - Performance-critical components
33
- - Complex algorithms or logic
34
- - Uncertain technical feasibility
35
-
36
- **Do NOT spike:**
37
- - Well-understood patterns
38
- - Standard CRUD operations
39
- - Simple UI changes
40
- - Routine implementations
41
-
42
- ### Step 3: Build Proof-of-Concept
43
- - Create minimal code to test assumptions
44
- - Focus on proving/disproving technical approach
45
- - Don't worry about production quality
46
- - Document what you're testing
47
-
48
- ### Step 4: Test Key Assumptions
49
- - Run the POC
50
- - Verify it works as expected
51
- - Test edge cases if relevant
52
- - Document findings
53
-
54
- ### Step 5: Get User Approval
55
- - Present POC to user
56
- - Explain what was validated
57
- - Share any findings or concerns
58
- - **Wait for explicit approval** before proceeding
59
-
60
- ### Step 6: Update Design Document
61
- If POC revealed:
62
- - Better approaches
63
- - Technical constraints
64
- - Performance considerations
65
- - Integration challenges
66
-
67
- **Update the design document** with findings
68
-
69
- ## VALIDATION
70
-
71
- ### Phase Complete When:
72
- - ✅ POC built and tested
73
- - ✅ Key technical assumptions validated
74
- - ✅ User has approved the approach
75
- - ✅ Design document updated (if needed)
76
- - ✅ Ready to proceed with full implementation
77
-
78
- ### Phase Incomplete If:
79
- - ❌ POC doesn't work as expected
80
- - ❌ Technical approach not viable
81
- - ❌ User hasn't approved
82
- - ❌ Significant findings not documented
83
-
84
- ## RULES FOR THIS PHASE
85
-
86
- ### Spike-First Development
87
- Read `registry/rules/spike-first-development.md` via `get_fraim_file` for complete spike methodology.
88
-
89
- ### Architecture Compliance
90
- Read `.fraim/config.json` for the architecture document path (`customizations.architectureDoc`), then read the local architecture document to understand the full architecture guidelines.
91
-
92
- ### Git Operations (if needed)
93
- When using git commands directly (if MCP tools unavailable), read `rules/git-safe-commands.md` via `get_fraim_file` to avoid interactive commands that hang agents.
94
-
95
- ## SCRIPTS
96
- Run POC:
97
- ```bash
98
- npm run spike # or appropriate command
99
- node spike/your-poc.js
100
- ```
101
-
102
- ### Report Back:
103
- When you complete this phase, call:
104
-
105
- ```javascript
106
- seekCoachingOnNextStep({
107
- workflowType: "implement",
108
- issueNumber: "{issue_number}",
109
- currentPhase: "implement-spike",
110
- status: "complete",
111
- findings: {
112
- issueType: "feature" // Required for phase validation
113
- },
114
- evidence: {
115
- pocLocation: "spike/auth-flow.ts",
116
- validationResults: "OAuth2 integration works as expected",
117
- userApproval: "User approved approach on [date]",
118
- designUpdates: "Updated design doc with token refresh findings"
119
- }
120
- })
121
- ```