fraim-framework 2.0.26 → 2.0.30
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/deploy-fraim.yml +1 -1
- package/dist/registry/scripts/build-scripts-generator.js +205 -0
- package/dist/registry/scripts/cleanup-branch.js +258 -0
- package/dist/registry/scripts/evaluate-code-quality.js +66 -0
- package/dist/registry/scripts/exec-with-timeout.js +142 -0
- package/dist/registry/scripts/fraim-config.js +61 -0
- package/dist/registry/scripts/generate-engagement-emails.js +630 -0
- package/dist/registry/scripts/generic-issues-api.js +100 -0
- package/dist/registry/scripts/newsletter-helpers.js +731 -0
- package/dist/registry/scripts/openapi-generator.js +664 -0
- package/dist/registry/scripts/performance/profile-server.js +390 -0
- package/dist/registry/scripts/run-thank-you-workflow.js +92 -0
- package/dist/registry/scripts/send-newsletter-simple.js +85 -0
- package/dist/registry/scripts/send-thank-you-emails.js +54 -0
- package/dist/registry/scripts/validate-openapi-limits.js +311 -0
- package/dist/registry/scripts/validate-test-coverage.js +262 -0
- package/dist/registry/scripts/verify-test-coverage.js +66 -0
- package/dist/src/cli/commands/init.js +14 -12
- package/dist/src/cli/commands/sync.js +19 -2
- package/dist/src/cli/fraim.js +24 -22
- package/dist/src/cli/setup/first-run.js +13 -6
- package/dist/src/fraim/config-loader.js +0 -8
- package/dist/src/fraim/db-service.js +26 -15
- package/dist/src/fraim/issues.js +67 -0
- package/dist/src/fraim/setup-wizard.js +1 -69
- package/dist/src/fraim/types.js +0 -11
- package/dist/src/fraim-mcp-server.js +272 -18
- package/dist/src/utils/git-utils.js +1 -1
- package/dist/src/utils/version-utils.js +32 -0
- package/dist/tests/debug-tools.js +79 -0
- package/dist/tests/esm-compat.js +11 -0
- package/dist/tests/test-chalk-esm-issue.js +159 -0
- package/dist/tests/test-chalk-real-world.js +265 -0
- package/dist/tests/test-chalk-regression.js +327 -0
- package/dist/tests/test-chalk-resolution-issue.js +304 -0
- package/dist/tests/test-cli.js +0 -2
- package/dist/tests/test-fraim-install-chalk-issue.js +254 -0
- package/dist/tests/test-fraim-issues.js +59 -0
- package/dist/tests/test-genericization.js +1 -3
- package/dist/tests/test-mcp-connection.js +166 -0
- package/dist/tests/test-mcp-issue-integration.js +144 -0
- package/dist/tests/test-mcp-lifecycle-methods.js +312 -0
- package/dist/tests/test-node-compatibility.js +71 -0
- package/dist/tests/test-npm-install.js +66 -0
- package/dist/tests/test-npm-resolution-diagnostic.js +140 -0
- package/dist/tests/test-session-rehydration.js +145 -0
- package/dist/tests/test-standalone.js +2 -8
- package/dist/tests/test-sync-version-update.js +93 -0
- package/dist/tests/test-telemetry.js +190 -0
- package/package.json +10 -8
- package/registry/agent-guardrails.md +62 -54
- package/registry/rules/agent-success-criteria.md +52 -0
- package/registry/rules/agent-testing-guidelines.md +502 -502
- package/registry/rules/communication.md +121 -121
- package/registry/rules/continuous-learning.md +54 -54
- package/registry/rules/ephemeral-execution.md +10 -5
- package/registry/rules/hitl-ppe-record-analysis.md +302 -302
- package/registry/rules/local-development.md +251 -251
- package/registry/rules/software-development-lifecycle.md +104 -104
- package/registry/rules/successful-debugging-patterns.md +482 -478
- package/registry/rules/telemetry.md +67 -0
- package/registry/scripts/build-scripts-generator.ts +216 -215
- package/registry/scripts/cleanup-branch.ts +303 -284
- package/registry/scripts/code-quality-check.sh +559 -559
- package/registry/scripts/detect-tautological-tests.sh +38 -38
- package/registry/scripts/evaluate-code-quality.ts +1 -1
- package/registry/scripts/generate-engagement-emails.ts +744 -744
- package/registry/scripts/generic-issues-api.ts +110 -150
- package/registry/scripts/newsletter-helpers.ts +874 -874
- package/registry/scripts/openapi-generator.ts +695 -693
- package/registry/scripts/performance/profile-server.ts +5 -3
- package/registry/scripts/prep-issue.sh +468 -455
- package/registry/scripts/validate-openapi-limits.ts +366 -365
- package/registry/scripts/validate-test-coverage.ts +280 -280
- package/registry/scripts/verify-pr-comments.sh +70 -70
- package/registry/scripts/verify-test-coverage.ts +1 -1
- package/registry/templates/bootstrap/ARCHITECTURE-TEMPLATE.md +53 -53
- package/registry/templates/evidence/Implementation-BugEvidence.md +85 -85
- package/registry/templates/evidence/Implementation-FeatureEvidence.md +120 -120
- package/registry/templates/marketing/HBR-ARTICLE-TEMPLATE.md +66 -0
- package/registry/workflows/bootstrap/create-architecture.md +2 -2
- package/registry/workflows/bootstrap/evaluate-code-quality.md +3 -3
- package/registry/workflows/bootstrap/verify-test-coverage.md +2 -2
- package/registry/workflows/customer-development/insight-analysis.md +156 -156
- package/registry/workflows/customer-development/interview-preparation.md +421 -421
- package/registry/workflows/customer-development/strategic-brainstorming.md +146 -146
- package/registry/workflows/customer-development/thank-customers.md +193 -191
- package/registry/workflows/customer-development/weekly-newsletter.md +362 -352
- package/registry/workflows/improve-fraim/contribute.md +32 -0
- package/registry/workflows/improve-fraim/file-issue.md +32 -0
- package/registry/workflows/marketing/hbr-article.md +73 -0
- package/registry/workflows/performance/analyze-performance.md +63 -59
- package/registry/workflows/product-building/design.md +3 -2
- package/registry/workflows/product-building/implement.md +4 -3
- package/registry/workflows/product-building/prep-issue.md +28 -17
- package/registry/workflows/product-building/resolve.md +3 -2
- package/registry/workflows/product-building/retrospect.md +3 -2
- package/registry/workflows/product-building/spec.md +5 -4
- package/registry/workflows/product-building/test.md +3 -2
- package/registry/workflows/quality-assurance/iterative-improvement-cycle.md +562 -562
- package/registry/workflows/replicate/website-discovery-analysis.md +3 -3
- package/registry/workflows/reviewer/review-implementation-vs-design-spec.md +632 -632
- package/registry/workflows/reviewer/review-implementation-vs-feature-spec.md +669 -669
- package/tsconfig.json +2 -1
|
@@ -1,105 +1,105 @@
|
|
|
1
|
-
# Software Development Lifecycle
|
|
2
|
-
|
|
3
|
-
## INTENT
|
|
4
|
-
To provide a structured, phase-based approach to issue resolution that ensures proper planning, implementation, testing, and cleanup while maintaining coordination with other agents and respecting project governance.
|
|
5
|
-
|
|
6
|
-
## PRINCIPLES
|
|
7
|
-
- **Phase-Based Development**: Clear phases with specific deliverables
|
|
8
|
-
- **Branch Safety**: Never work on master, always use feature branches
|
|
9
|
-
- **Local Development**: Work in isolated clones to prevent conflicts
|
|
10
|
-
- **Coordination**: Use GitHub for agent coordination and status management
|
|
11
|
-
- **Governance**: Respect CODEOWNERS and project policies
|
|
12
|
-
|
|
13
|
-
## CORE WORKFLOW
|
|
14
|
-
Always work on the feature branch for the current issue: `feature/<issue#>-<kebab-title>`. Never push to master.
|
|
15
|
-
|
|
16
|
-
### Development Workflow
|
|
17
|
-
1. **Clone Setup**: Work in your own cloned repository folder. Folder name should be `Ashley Calendar AI - Issue {issue_number}`
|
|
18
|
-
2. **Branch Management**: Create/checkout feature branch for your issue
|
|
19
|
-
3. **Local Development**: Make changes, run tests locally
|
|
20
|
-
4. **Check before commit**: Only commit after approval from the user.
|
|
21
|
-
5. **Remote Coordination**: Use GitHub MCP for issue labels
|
|
22
|
-
|
|
23
|
-
## MANDATORY PRE-COMMIT VALIDATION
|
|
24
|
-
Before ANY commit, run: `git branch` and verify NOT on master
|
|
25
|
-
|
|
26
|
-
## PHASES
|
|
27
|
-
|
|
28
|
-
### Design Phase
|
|
29
|
-
- **Trigger**: Set ISSUE to `phase:design`
|
|
30
|
-
- **Deliverable**: Create RFC document
|
|
31
|
-
- **Status**: Automatically set to `status:wip`
|
|
32
|
-
|
|
33
|
-
### Implementation Phase
|
|
34
|
-
- **Trigger**: Set ISSUE to `phase:impl`
|
|
35
|
-
- **Deliverable**: Working code with tests
|
|
36
|
-
- **Status**: Set to `status:needs-review` when ready
|
|
37
|
-
|
|
38
|
-
## STATUS MANAGEMENT
|
|
39
|
-
- **WIP**: Automatically set when entering new phase
|
|
40
|
-
- **Needs Review**: Set this when work is ready for review
|
|
41
|
-
- **Complete**: Automatically set when PR is approved
|
|
42
|
-
|
|
43
|
-
## EXAMPLES
|
|
44
|
-
|
|
45
|
-
### Good: Proper Phase Management
|
|
46
|
-
```
|
|
47
|
-
Issue #84: "Fix calendar sync timeout"
|
|
48
|
-
1. Set phase:design → Create RFC for retry logic
|
|
49
|
-
2. Set phase:impl → Implement exponential backoff
|
|
50
|
-
3. Set status:needs-review → Ready for code review
|
|
51
|
-
4. PR approved → Set status:complete
|
|
52
|
-
Result: Clear progression through phases
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
### Bad: Skipping Phases
|
|
56
|
-
```
|
|
57
|
-
Issue #84: "Fix calendar sync timeout"
|
|
58
|
-
1. Jump straight to coding without design
|
|
59
|
-
2. No RFC created
|
|
60
|
-
3. Implementation lacks proper planning
|
|
61
|
-
Result: Incomplete solution, potential rework
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
## PRE-PHASE VALIDATION
|
|
65
|
-
|
|
66
|
-
### Before Starting Any Phase
|
|
67
|
-
Agents MUST complete validation checklist:
|
|
68
|
-
|
|
69
|
-
1. **Read Relevant Rules**:
|
|
70
|
-
- [ ] Read
|
|
71
|
-
- [ ] Read phase-specific workflow (
|
|
72
|
-
- [ ] Read retrospectives folder thoroughly and understand past learnings
|
|
73
|
-
|
|
74
|
-
2. **Verify Environment**:
|
|
75
|
-
- [ ] Confirm working directory is correct
|
|
76
|
-
- [ ] Verify branch exists and is checked out
|
|
77
|
-
- [ ] Check issue labels are correct
|
|
78
|
-
|
|
79
|
-
3. **Template Validation**:
|
|
80
|
-
- [ ] Locate correct template file
|
|
81
|
-
- [ ] Verify template exists and is readable
|
|
82
|
-
- [ ] Confirm naming convention understanding
|
|
83
|
-
|
|
84
|
-
4. **Technical Understanding**:
|
|
85
|
-
- [ ] Understand relevant technical patterns for the issue
|
|
86
|
-
- [ ] Plan test strategy for core functionality
|
|
87
|
-
|
|
88
|
-
### Validation Failure Response
|
|
89
|
-
If any validation step fails:
|
|
90
|
-
1. Stop work immediately
|
|
91
|
-
2. Read missing documentation
|
|
92
|
-
3. Ask clarifying questions if needed
|
|
93
|
-
4. Resume only after validation complete
|
|
94
|
-
|
|
95
|
-
## CLEANUP
|
|
96
|
-
When user confirms code is correctly merged into master, confirm with the user, then
|
|
97
|
-
- delete remote branch
|
|
98
|
-
- delete local branch
|
|
99
|
-
- remove your local clone folder:
|
|
100
|
-
```
|
|
101
|
-
cd ..
|
|
102
|
-
Remove-Item -Recurse -Force "Ashley Calendar AI - Issue {issue_number}"
|
|
103
|
-
```
|
|
104
|
-
|
|
1
|
+
# Software Development Lifecycle
|
|
2
|
+
|
|
3
|
+
## INTENT
|
|
4
|
+
To provide a structured, phase-based approach to issue resolution that ensures proper planning, implementation, testing, and cleanup while maintaining coordination with other agents and respecting project governance.
|
|
5
|
+
|
|
6
|
+
## PRINCIPLES
|
|
7
|
+
- **Phase-Based Development**: Clear phases with specific deliverables
|
|
8
|
+
- **Branch Safety**: Never work on master, always use feature branches
|
|
9
|
+
- **Local Development**: Work in isolated clones to prevent conflicts
|
|
10
|
+
- **Coordination**: Use GitHub for agent coordination and status management
|
|
11
|
+
- **Governance**: Respect CODEOWNERS and project policies
|
|
12
|
+
|
|
13
|
+
## CORE WORKFLOW
|
|
14
|
+
Always work on the feature branch for the current issue: `feature/<issue#>-<kebab-title>`. Never push to master.
|
|
15
|
+
|
|
16
|
+
### Development Workflow
|
|
17
|
+
1. **Clone Setup**: Work in your own cloned repository folder. Folder name should be `Ashley Calendar AI - Issue {issue_number}`
|
|
18
|
+
2. **Branch Management**: Create/checkout feature branch for your issue
|
|
19
|
+
3. **Local Development**: Make changes, run tests locally
|
|
20
|
+
4. **Check before commit**: Only commit after approval from the user.
|
|
21
|
+
5. **Remote Coordination**: Use GitHub MCP for issue labels
|
|
22
|
+
|
|
23
|
+
## MANDATORY PRE-COMMIT VALIDATION
|
|
24
|
+
Before ANY commit, run: `git branch` and verify NOT on master
|
|
25
|
+
|
|
26
|
+
## PHASES
|
|
27
|
+
|
|
28
|
+
### Design Phase
|
|
29
|
+
- **Trigger**: Set ISSUE to `phase:design`
|
|
30
|
+
- **Deliverable**: Create RFC document
|
|
31
|
+
- **Status**: Automatically set to `status:wip`
|
|
32
|
+
|
|
33
|
+
### Implementation Phase
|
|
34
|
+
- **Trigger**: Set ISSUE to `phase:impl`
|
|
35
|
+
- **Deliverable**: Working code with tests
|
|
36
|
+
- **Status**: Set to `status:needs-review` when ready
|
|
37
|
+
|
|
38
|
+
## STATUS MANAGEMENT
|
|
39
|
+
- **WIP**: Automatically set when entering new phase
|
|
40
|
+
- **Needs Review**: Set this when work is ready for review
|
|
41
|
+
- **Complete**: Automatically set when PR is approved
|
|
42
|
+
|
|
43
|
+
## EXAMPLES
|
|
44
|
+
|
|
45
|
+
### Good: Proper Phase Management
|
|
46
|
+
```
|
|
47
|
+
Issue #84: "Fix calendar sync timeout"
|
|
48
|
+
1. Set phase:design → Create RFC for retry logic
|
|
49
|
+
2. Set phase:impl → Implement exponential backoff
|
|
50
|
+
3. Set status:needs-review → Ready for code review
|
|
51
|
+
4. PR approved → Set status:complete
|
|
52
|
+
Result: Clear progression through phases
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Bad: Skipping Phases
|
|
56
|
+
```
|
|
57
|
+
Issue #84: "Fix calendar sync timeout"
|
|
58
|
+
1. Jump straight to coding without design
|
|
59
|
+
2. No RFC created
|
|
60
|
+
3. Implementation lacks proper planning
|
|
61
|
+
Result: Incomplete solution, potential rework
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## PRE-PHASE VALIDATION
|
|
65
|
+
|
|
66
|
+
### Before Starting Any Phase
|
|
67
|
+
Agents MUST complete validation checklist:
|
|
68
|
+
|
|
69
|
+
1. **Read Relevant Rules**:
|
|
70
|
+
- [ ] Read `get_fraim_file({ path: "rules/software-development-lifecycle.md" })`
|
|
71
|
+
- [ ] Read phase-specific workflow via `get_fraim_file` (e.g. `workflows/product-building/design.md`)
|
|
72
|
+
- [ ] Read retrospectives folder thoroughly and understand past learnings
|
|
73
|
+
|
|
74
|
+
2. **Verify Environment**:
|
|
75
|
+
- [ ] Confirm working directory is correct
|
|
76
|
+
- [ ] Verify branch exists and is checked out
|
|
77
|
+
- [ ] Check issue labels are correct
|
|
78
|
+
|
|
79
|
+
3. **Template Validation**:
|
|
80
|
+
- [ ] Locate correct template file
|
|
81
|
+
- [ ] Verify template exists and is readable
|
|
82
|
+
- [ ] Confirm naming convention understanding
|
|
83
|
+
|
|
84
|
+
4. **Technical Understanding**:
|
|
85
|
+
- [ ] Understand relevant technical patterns for the issue
|
|
86
|
+
- [ ] Plan test strategy for core functionality
|
|
87
|
+
|
|
88
|
+
### Validation Failure Response
|
|
89
|
+
If any validation step fails:
|
|
90
|
+
1. Stop work immediately
|
|
91
|
+
2. Read missing documentation
|
|
92
|
+
3. Ask clarifying questions if needed
|
|
93
|
+
4. Resume only after validation complete
|
|
94
|
+
|
|
95
|
+
## CLEANUP
|
|
96
|
+
When user confirms code is correctly merged into master, confirm with the user, then
|
|
97
|
+
- delete remote branch
|
|
98
|
+
- delete local branch
|
|
99
|
+
- remove your local clone folder:
|
|
100
|
+
```
|
|
101
|
+
cd ..
|
|
102
|
+
Remove-Item -Recurse -Force "Ashley Calendar AI - Issue {issue_number}"
|
|
103
|
+
```
|
|
104
|
+
|
|
105
105
|
Respect CODEOWNERS; don't modify auth/CI without approval.
|