fraim-framework 2.0.66 → 2.0.67
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/dist/registry/ai-manager-rules/customer-development-phases/phase1-customer-profiling.md +101 -0
- package/dist/registry/ai-manager-rules/customer-development-phases/phase2-platform-discovery.md +235 -0
- package/dist/registry/ai-manager-rules/customer-development-phases/phase3-prospect-qualification.md +243 -0
- package/dist/registry/ai-manager-rules/customer-development-phases/phase4-inventory-compilation.md +206 -0
- package/dist/registry/ai-manager-rules/design-phases/design-completeness-review.md +73 -0
- package/dist/registry/ai-manager-rules/design-phases/design-design.md +145 -0
- package/dist/registry/ai-manager-rules/design-phases/design.md +108 -0
- package/dist/registry/ai-manager-rules/design-phases/finalize.md +60 -0
- package/dist/registry/ai-manager-rules/design-phases/validate.md +125 -0
- package/dist/registry/ai-manager-rules/design.json +97 -0
- package/dist/registry/ai-manager-rules/implement-phases/code.md +323 -0
- package/dist/registry/ai-manager-rules/implement-phases/completeness-review.md +94 -0
- package/dist/registry/ai-manager-rules/implement-phases/finalize.md +177 -0
- package/dist/registry/ai-manager-rules/implement-phases/implement-code.md +283 -0
- package/dist/registry/ai-manager-rules/implement-phases/implement-completeness-review.md +120 -0
- package/dist/registry/ai-manager-rules/implement-phases/implement-regression.md +173 -0
- package/dist/registry/ai-manager-rules/implement-phases/implement-repro.md +104 -0
- package/dist/registry/ai-manager-rules/implement-phases/implement-scoping.md +100 -0
- package/dist/registry/ai-manager-rules/implement-phases/implement-smoke.md +237 -0
- package/dist/registry/ai-manager-rules/implement-phases/implement-spike.md +121 -0
- package/dist/registry/ai-manager-rules/implement-phases/implement-validate.md +375 -0
- package/dist/registry/ai-manager-rules/implement-phases/quality-review.md +304 -0
- package/dist/registry/ai-manager-rules/implement-phases/regression.md +159 -0
- package/dist/registry/ai-manager-rules/implement-phases/repro.md +101 -0
- package/dist/registry/ai-manager-rules/implement-phases/scoping.md +93 -0
- package/dist/registry/ai-manager-rules/implement-phases/smoke.md +225 -0
- package/dist/registry/ai-manager-rules/implement-phases/spike.md +118 -0
- package/dist/registry/ai-manager-rules/implement-phases/validate.md +347 -0
- package/dist/registry/ai-manager-rules/implement.json +153 -0
- package/dist/registry/ai-manager-rules/retrospective.md +116 -0
- package/dist/registry/ai-manager-rules/shared-phases/address-pr-feedback.md +188 -0
- package/dist/registry/ai-manager-rules/shared-phases/finalize.md +169 -0
- package/dist/registry/ai-manager-rules/shared-phases/submit-pr.md +202 -0
- package/dist/registry/ai-manager-rules/shared-phases/wait-for-pr-review.md +170 -0
- package/dist/registry/ai-manager-rules/spec-phases/finalize.md +60 -0
- package/dist/registry/ai-manager-rules/spec-phases/spec-competitor-analysis.md +105 -0
- package/dist/registry/ai-manager-rules/spec-phases/spec-completeness-review.md +66 -0
- package/dist/registry/ai-manager-rules/spec-phases/spec-spec.md +139 -0
- package/dist/registry/ai-manager-rules/spec-phases/spec.md +102 -0
- package/dist/registry/ai-manager-rules/spec-phases/validate.md +118 -0
- package/dist/registry/ai-manager-rules/spec.json +112 -0
- package/dist/registry/ai-manager-rules/test.json +98 -0
- package/dist/registry/ai-manager-rules/user-survey-phases/phase1-survey-scoping.md +60 -0
- package/dist/registry/ai-manager-rules/user-survey-phases/phase2-survey-build-linkedin.md +23 -0
- package/dist/registry/ai-manager-rules/user-survey-phases/phase3-survey-build-reddit.md +22 -0
- package/dist/registry/ai-manager-rules/user-survey-phases/phase4-survey-build-x.md +21 -0
- package/dist/registry/ai-manager-rules/user-survey-phases/phase5-survey-build-facebook.md +19 -0
- package/dist/registry/ai-manager-rules/user-survey-phases/phase6-survey-build-custom.md +15 -0
- package/dist/registry/ai-manager-rules/user-survey-phases/phase7-survey-dispatch.md +45 -0
- package/dist/registry/delivery/address-feedback.md +83 -0
- package/dist/registry/delivery/retrospective.md +78 -0
- package/dist/registry/delivery/submit.md +79 -0
- package/dist/registry/providers/ado.json +19 -0
- package/dist/registry/providers/delivery-conversation.json +9 -0
- package/dist/registry/providers/delivery-pr.json +9 -0
- package/dist/registry/providers/github.json +19 -0
- package/dist/registry/rules/agent-success-criteria.md +101 -0
- package/dist/registry/rules/agent-testing-guidelines.md +502 -0
- package/dist/registry/rules/architecture.md +126 -0
- package/dist/registry/rules/communication.md +122 -0
- package/dist/registry/rules/continuous-learning.md +55 -0
- package/dist/registry/rules/debugging-multitenancy-issues.md +85 -0
- package/dist/registry/rules/ephemeral-execution.md +54 -0
- package/dist/registry/rules/git-safe-commands.md +34 -0
- package/dist/registry/rules/hitl-ppe-record-analysis.md +302 -0
- package/dist/registry/rules/integrity-and-test-ethics.md +275 -0
- package/dist/registry/rules/local-development.md +275 -0
- package/dist/registry/rules/mandatory-pre-completion-reflection.md +193 -0
- package/dist/registry/rules/merge-requirements.md +238 -0
- package/dist/registry/rules/simplicity.md +118 -0
- package/dist/registry/rules/software-development-lifecycle.md +105 -0
- package/dist/registry/rules/spike-first-development.md +205 -0
- package/dist/registry/rules/successful-debugging-patterns.md +488 -0
- package/dist/registry/scripts/build-scripts-generator.js +205 -0
- package/dist/registry/scripts/cleanup-branch.js +287 -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 +705 -0
- package/dist/registry/scripts/generic-issues-api.js +100 -0
- package/dist/registry/scripts/newsletter-helpers.js +671 -0
- package/dist/registry/scripts/openapi-generator.js +664 -0
- package/dist/registry/scripts/performance/profile-server.js +390 -0
- package/dist/registry/scripts/profile-server.js +389 -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/registry/stubs/workflows/azure/cost-optimization.md +11 -0
- package/dist/registry/stubs/workflows/bootstrap/create-architecture.md +11 -0
- package/dist/registry/stubs/workflows/bootstrap/detect-broken-windows.md +11 -0
- package/dist/registry/stubs/workflows/bootstrap/evaluate-code-quality.md +11 -0
- package/dist/registry/stubs/workflows/bootstrap/verify-test-coverage.md +11 -0
- package/dist/registry/stubs/workflows/brainstorming/blue-sky-brainstorming.md +11 -0
- package/dist/registry/stubs/workflows/brainstorming/codebase-brainstorming.md +11 -0
- package/dist/registry/stubs/workflows/business-development/create-business-plan.md +11 -0
- package/dist/registry/stubs/workflows/business-development/ideate-business-opportunity.md +11 -0
- package/dist/registry/stubs/workflows/business-development/price-product.md +18 -0
- package/dist/registry/stubs/workflows/compliance/detect-compliance-requirements.md +11 -0
- package/dist/registry/stubs/workflows/compliance/generate-audit-evidence.md +11 -0
- package/dist/registry/stubs/workflows/compliance/soc2-evidence-generator.md +11 -0
- package/dist/registry/stubs/workflows/customer-development/insight-analysis.md +11 -0
- package/dist/registry/stubs/workflows/customer-development/insight-triage.md +11 -0
- package/dist/registry/stubs/workflows/customer-development/interview-preparation.md +11 -0
- package/dist/registry/stubs/workflows/customer-development/linkedin-outreach.md +11 -0
- package/dist/registry/stubs/workflows/customer-development/strategic-brainstorming.md +11 -0
- package/dist/registry/stubs/workflows/customer-development/thank-customers.md +11 -0
- package/dist/registry/stubs/workflows/customer-development/user-survey-dispatch.md +11 -0
- package/dist/registry/stubs/workflows/customer-development/users-to-target.md +11 -0
- package/dist/registry/stubs/workflows/customer-development/weekly-newsletter.md +11 -0
- package/dist/registry/stubs/workflows/deploy/cloud-deployment.md +11 -0
- package/dist/registry/stubs/workflows/improve-fraim/contribute.md +11 -0
- package/dist/registry/stubs/workflows/improve-fraim/file-issue.md +11 -0
- package/dist/registry/stubs/workflows/learning/build-skillset.md +11 -0
- package/dist/registry/stubs/workflows/learning/synthesize-learnings.md +11 -0
- package/dist/registry/stubs/workflows/legal/contract-review-analysis.md +11 -0
- package/dist/registry/stubs/workflows/legal/nda.md +11 -0
- package/dist/registry/stubs/workflows/legal/patent-filing.md +11 -0
- package/dist/registry/stubs/workflows/legal/saas-contract-development.md +11 -0
- package/dist/registry/stubs/workflows/legal/trademark-filing.md +11 -0
- package/dist/registry/stubs/workflows/marketing/content-creation.md +11 -0
- package/dist/registry/stubs/workflows/marketing/convert-to-pdf.md +11 -0
- package/dist/registry/stubs/workflows/marketing/create-modern-website.md +11 -0
- package/dist/registry/stubs/workflows/marketing/domain-registration.md +11 -0
- package/dist/registry/stubs/workflows/marketing/evangelize.md +11 -0
- package/dist/registry/stubs/workflows/marketing/hbr-article.md +11 -0
- package/dist/registry/stubs/workflows/marketing/launch-checklist.md +11 -0
- package/dist/registry/stubs/workflows/marketing/marketing-strategy.md +11 -0
- package/dist/registry/stubs/workflows/marketing/storytelling.md +11 -0
- package/dist/registry/stubs/workflows/performance/analyze-performance.md +11 -0
- package/dist/registry/stubs/workflows/product-building/design.md +11 -0
- package/dist/registry/stubs/workflows/product-building/implement.md +11 -0
- package/dist/registry/stubs/workflows/product-building/iterate-on-pr-comments.md +11 -0
- package/dist/registry/stubs/workflows/product-building/prep-issue.md +11 -0
- package/dist/registry/stubs/workflows/product-building/prototype.md +11 -0
- package/dist/registry/stubs/workflows/product-building/resolve.md +11 -0
- package/dist/registry/stubs/workflows/product-building/retrospect.md +11 -0
- package/dist/registry/stubs/workflows/product-building/spec.md +11 -0
- package/dist/registry/stubs/workflows/product-building/test.md +11 -0
- package/dist/registry/stubs/workflows/productivity-report/productivity-report.md +11 -0
- package/dist/registry/stubs/workflows/quality-assurance/browser-validation.md +11 -0
- package/dist/registry/stubs/workflows/quality-assurance/iterative-improvement-cycle.md +11 -0
- package/dist/registry/stubs/workflows/replicate/replicate-discovery.md +11 -0
- package/dist/registry/stubs/workflows/replicate/replicate-to-issues.md +11 -0
- package/dist/registry/stubs/workflows/reviewer/review-implementation-vs-design-spec.md +11 -0
- package/dist/registry/stubs/workflows/reviewer/review-implementation-vs-feature-spec.md +11 -0
- package/dist/registry/stubs/workflows/startup-credits/aws-activate-application.md +11 -0
- package/dist/registry/stubs/workflows/startup-credits/google-cloud-application.md +11 -0
- package/dist/registry/stubs/workflows/startup-credits/microsoft-azure-application.md +11 -0
- package/dist/registry/templates/bootstrap/ARCHITECTURE-TEMPLATE.md +53 -0
- package/dist/registry/templates/bootstrap/CODE-QUALITY-REPORT-TEMPLATE.md +37 -0
- package/dist/registry/templates/bootstrap/TEST-COVERAGE-REPORT-TEMPLATE.md +35 -0
- package/dist/registry/templates/business-development/IDEATION-REPORT-TEMPLATE.md +29 -0
- package/dist/registry/templates/business-development/PRICING-STRATEGY-TEMPLATE.md +126 -0
- package/dist/registry/templates/customer-development/customer-interview-template.md +99 -0
- package/dist/registry/templates/customer-development/customer-persona-template.md +69 -0
- package/dist/registry/templates/customer-development/follow-up-email-templates.md +132 -0
- package/dist/registry/templates/customer-development/insight-analysis-template.md +74 -0
- package/dist/registry/templates/customer-development/prospect-inventory-template.csv +3 -0
- package/dist/registry/templates/customer-development/search-strategy-template.md +123 -0
- package/dist/registry/templates/customer-development/strategic-recommendations-template.md +53 -0
- package/dist/registry/templates/customer-development/thank-you-email-template.html +124 -0
- package/dist/registry/templates/customer-development/thank-you-note-template.md +16 -0
- package/dist/registry/templates/customer-development/triage-log-template.md +278 -0
- package/dist/registry/templates/customer-development/weekly-newsletter-template.html +204 -0
- package/dist/registry/templates/evidence/Design-Evidence.md +30 -0
- package/dist/registry/templates/evidence/Implementation-BugEvidence.md +122 -0
- package/dist/registry/templates/evidence/Implementation-FeatureEvidence.md +160 -0
- package/dist/registry/templates/evidence/Spec-Evidence.md +19 -0
- package/dist/registry/templates/help/HelpNeeded.md +14 -0
- package/dist/registry/templates/legal/NDA-TEMPLATE.md +170 -0
- package/dist/registry/templates/legal/PATENT-TEMPLATE.md +372 -0
- package/dist/registry/templates/legal/TRADEMARK-TEMPLATE.md +339 -0
- package/dist/registry/templates/legal/contract-review-checklist.md +193 -0
- package/dist/registry/templates/legal/review-report-template.md +198 -0
- package/dist/registry/templates/legal/saas-terms-template.md +174 -0
- package/dist/registry/templates/legal/sow-template.md +117 -0
- package/dist/registry/templates/legal/template-variables.md +131 -0
- package/dist/registry/templates/marketing/DOMAIN-REGISTRATION-TEMPLATE.md +194 -0
- package/dist/registry/templates/marketing/EVANGELIZE-TEMPLATE.md +102 -0
- package/dist/registry/templates/marketing/HBR-ARTICLE-TEMPLATE.md +66 -0
- package/dist/registry/templates/marketing/STORYTELLING-TEMPLATE.md +130 -0
- package/dist/registry/templates/marketing/WEBSITE-TEMPLATE.md +262 -0
- package/dist/registry/templates/marketing/github-pages-workflow.yml +64 -0
- package/dist/registry/templates/replicate/implementation-checklist.md +39 -0
- package/dist/registry/templates/replicate/use-cases-template.md +88 -0
- package/dist/registry/templates/retrospective/RETROSPECTIVE-TEMPLATE.md +55 -0
- package/dist/registry/templates/specs/BUGSPEC-TEMPLATE.md +37 -0
- package/dist/registry/templates/specs/FEATURESPEC-TEMPLATE.md +66 -0
- package/dist/registry/templates/specs/TECHSPEC-TEMPLATE.md +39 -0
- package/dist/registry/workflows/azure/cost-optimization.md +772 -0
- package/dist/registry/workflows/bootstrap/create-architecture.md +37 -0
- package/dist/registry/workflows/bootstrap/detect-broken-windows.md +300 -0
- package/dist/registry/workflows/bootstrap/evaluate-code-quality.md +35 -0
- package/dist/registry/workflows/bootstrap/verify-test-coverage.md +36 -0
- package/dist/registry/workflows/brainstorming/blue-sky-brainstorming.md +211 -0
- package/dist/registry/workflows/brainstorming/codebase-brainstorming.md +159 -0
- package/dist/registry/workflows/business-development/create-business-plan.md +737 -0
- package/dist/registry/workflows/business-development/ideate-business-opportunity.md +55 -0
- package/dist/registry/workflows/business-development/price-product.md +325 -0
- package/dist/registry/workflows/compliance/detect-compliance-requirements.md +80 -0
- package/dist/registry/workflows/compliance/generate-audit-evidence.md +80 -0
- package/dist/registry/workflows/compliance/soc2-evidence-generator.md +332 -0
- package/dist/registry/workflows/customer-development/insight-analysis.md +156 -0
- package/dist/registry/workflows/customer-development/insight-triage.md +933 -0
- package/dist/registry/workflows/customer-development/interview-preparation.md +452 -0
- package/dist/registry/workflows/customer-development/linkedin-outreach.md +599 -0
- package/dist/registry/workflows/customer-development/strategic-brainstorming.md +146 -0
- package/dist/registry/workflows/customer-development/thank-customers.md +203 -0
- package/dist/registry/workflows/customer-development/user-survey-dispatch.md +312 -0
- package/dist/registry/workflows/customer-development/users-to-target.md +427 -0
- package/dist/registry/workflows/customer-development/weekly-newsletter.md +366 -0
- package/dist/registry/workflows/deploy/cloud-deployment.md +310 -0
- package/dist/registry/workflows/improve-fraim/contribute.md +32 -0
- package/dist/registry/workflows/improve-fraim/file-issue.md +32 -0
- package/dist/registry/workflows/learning/build-skillset.md +212 -0
- package/dist/registry/workflows/learning/synthesize-learnings.md +369 -0
- package/dist/registry/workflows/legal/contract-review-analysis.md +382 -0
- package/dist/registry/workflows/legal/nda.md +69 -0
- package/dist/registry/workflows/legal/patent-filing.md +76 -0
- package/dist/registry/workflows/legal/saas-contract-development.md +204 -0
- package/dist/registry/workflows/legal/trademark-filing.md +77 -0
- package/dist/registry/workflows/marketing/content-creation.md +40 -0
- package/dist/registry/workflows/marketing/convert-to-pdf.md +265 -0
- package/dist/registry/workflows/marketing/create-modern-website.md +456 -0
- package/dist/registry/workflows/marketing/domain-registration.md +323 -0
- package/dist/registry/workflows/marketing/evangelize.md +426 -0
- package/dist/registry/workflows/marketing/hbr-article.md +73 -0
- package/dist/registry/workflows/marketing/launch-checklist.md +37 -0
- package/dist/registry/workflows/marketing/marketing-strategy.md +45 -0
- package/dist/registry/workflows/marketing/storytelling.md +65 -0
- package/dist/registry/workflows/performance/analyze-performance.md +65 -0
- package/dist/registry/workflows/product-building/design.md +263 -0
- package/dist/registry/workflows/product-building/implement.md +771 -0
- package/dist/registry/workflows/product-building/iterate-on-pr-comments.md +70 -0
- package/dist/registry/workflows/product-building/prep-issue.md +41 -0
- package/dist/registry/workflows/product-building/prototype.md +60 -0
- package/dist/registry/workflows/product-building/resolve.md +175 -0
- package/dist/registry/workflows/product-building/retrospect.md +86 -0
- package/dist/registry/workflows/product-building/spec.md +303 -0
- package/dist/registry/workflows/product-building/test.md +125 -0
- package/dist/registry/workflows/productivity-report/productivity-report.md +263 -0
- package/dist/registry/workflows/quality-assurance/browser-validation.md +221 -0
- package/dist/registry/workflows/quality-assurance/iterative-improvement-cycle.md +562 -0
- package/dist/registry/workflows/replicate/replicate-discovery.md +336 -0
- package/dist/registry/workflows/replicate/replicate-to-issues.md +319 -0
- package/dist/registry/workflows/reviewer/review-implementation-vs-design-spec.md +694 -0
- package/dist/registry/workflows/reviewer/review-implementation-vs-feature-spec.md +734 -0
- package/dist/registry/workflows/startup-credits/aws-activate-application.md +535 -0
- package/dist/registry/workflows/startup-credits/google-cloud-application.md +647 -0
- package/dist/registry/workflows/startup-credits/microsoft-azure-application.md +538 -0
- package/package.json +2 -1
|
@@ -0,0 +1,153 @@
|
|
|
1
|
+
{
|
|
2
|
+
"workflowType": "implement",
|
|
3
|
+
"description": "Implementation phase validation ensures that code changes are complete, properly tested with high-quality tests, and ready for production deployment. This phase enforces rigorous testing standards and design completeness.",
|
|
4
|
+
"validationRules": [
|
|
5
|
+
{
|
|
6
|
+
"step": 1,
|
|
7
|
+
"description": "Verify issue is labeled with phase:implement",
|
|
8
|
+
"passCriteria": "Issue has 'phase:implement' label applied",
|
|
9
|
+
"weight": "blocking",
|
|
10
|
+
"category": "process"
|
|
11
|
+
},
|
|
12
|
+
{
|
|
13
|
+
"step": 2,
|
|
14
|
+
"description": "Verify all aspects of design are complete",
|
|
15
|
+
"passCriteria": "All design requirements from spec/RFC are implemented: API contracts, data models, user interfaces, error handling patterns, and integration points. No placeholder code or TODO comments remain for core functionality.",
|
|
16
|
+
"weight": "blocking",
|
|
17
|
+
"category": "design-completeness"
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"step": 3,
|
|
21
|
+
"description": "Verify all test cases from design document are written",
|
|
22
|
+
"passCriteria": "Every test case specified in the design document/RFC validation plan has a corresponding automated test. Test coverage includes all user scenarios, edge cases, and error conditions outlined in the design.",
|
|
23
|
+
"weight": "blocking",
|
|
24
|
+
"category": "test-completeness"
|
|
25
|
+
},
|
|
26
|
+
{
|
|
27
|
+
"step": 4,
|
|
28
|
+
"description": "Verify all test cases follow architecture standards",
|
|
29
|
+
"passCriteria": "Tests follow the Shared Server Architecture pattern from docs/architecture/architecture.md: use shared-server-utils.ts, unique API keys per test, proper cleanup in finally blocks, no individual server instances, proper timeouts (5-10s for network calls).",
|
|
30
|
+
"weight": "blocking",
|
|
31
|
+
"category": "test-architecture"
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
"step": 5,
|
|
35
|
+
"description": "Verify all test cases have been run and are passing",
|
|
36
|
+
"passCriteria": "All tests pass successfully. Test output shows 0 failures, 0 timeouts, and all assertions succeed. Tests complete within reasonable time limits (<60s total, <10s per test).",
|
|
37
|
+
"weight": "blocking",
|
|
38
|
+
"category": "test-execution"
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"step": 6,
|
|
42
|
+
"description": "Verify tests do not mock the objects they should be testing",
|
|
43
|
+
"passCriteria": "Tests validate real functionality, not mocked behavior. Core business logic is tested against actual implementations. Mocks are only used for external dependencies (databases, APIs, file system) not for the code under test.",
|
|
44
|
+
"weight": "blocking",
|
|
45
|
+
"category": "test-quality"
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"step": 7,
|
|
49
|
+
"description": "Verify tests do not default to passing when unable to test",
|
|
50
|
+
"passCriteria": "No tests contain 'return true' without validation, empty test bodies, or assertions that always pass. Every test performs meaningful validation of expected behavior and will fail if the code is broken.",
|
|
51
|
+
"weight": "blocking",
|
|
52
|
+
"category": "test-quality"
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"step": 8,
|
|
56
|
+
"description": "Verify tests use flow testing instead of static analysis",
|
|
57
|
+
"passCriteria": "Tests execute actual code paths and validate runtime behavior. Tests call functions, trigger workflows, and verify outcomes. Static analysis (type checking, linting) supplements but does not replace functional testing.",
|
|
58
|
+
"weight": "blocking",
|
|
59
|
+
"category": "test-quality"
|
|
60
|
+
},
|
|
61
|
+
{
|
|
62
|
+
"step": 9,
|
|
63
|
+
"description": "Check TypeScript compilation passes",
|
|
64
|
+
"command": "npx tsc --noEmit --skipLibCheck",
|
|
65
|
+
"passCriteria": "TypeScript compilation completes without errors",
|
|
66
|
+
"weight": "blocking",
|
|
67
|
+
"category": "code-quality"
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"step": 10,
|
|
71
|
+
"description": "Check code quality standards",
|
|
72
|
+
"passCriteria": "No 'as any' type bypassing, proper error handling, consistent code style, meaningful variable names, and appropriate code comments",
|
|
73
|
+
"weight": "blocking",
|
|
74
|
+
"category": "code-quality"
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"step": 11,
|
|
78
|
+
"description": "Verify implementation matches design exactly",
|
|
79
|
+
"passCriteria": "Implementation follows the technical design/RFC precisely and addresses all specified requirements. API signatures, data structures, and behavior match the design specification.",
|
|
80
|
+
"weight": "blocking",
|
|
81
|
+
"category": "design-compliance"
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
"step": 12,
|
|
85
|
+
"description": "Check comprehensive error handling and edge cases",
|
|
86
|
+
"passCriteria": "Proper error handling implemented for all failure scenarios, edge cases covered with tests, graceful degradation where appropriate, and meaningful error messages",
|
|
87
|
+
"weight": "blocking",
|
|
88
|
+
"category": "robustness"
|
|
89
|
+
},
|
|
90
|
+
{
|
|
91
|
+
"step": 13,
|
|
92
|
+
"description": "Validate API contracts and interfaces",
|
|
93
|
+
"passCriteria": "All API contracts match specification, proper input validation, consistent response formats, and backward compatibility maintained",
|
|
94
|
+
"weight": "blocking",
|
|
95
|
+
"category": "api-compliance"
|
|
96
|
+
},
|
|
97
|
+
{
|
|
98
|
+
"step": 14,
|
|
99
|
+
"description": "Check security best practices",
|
|
100
|
+
"passCriteria": "Input sanitization, proper authentication/authorization, no security vulnerabilities, secure handling of sensitive data",
|
|
101
|
+
"weight": "blocking",
|
|
102
|
+
"category": "security"
|
|
103
|
+
},
|
|
104
|
+
{
|
|
105
|
+
"step": 15,
|
|
106
|
+
"description": "Check documentation is updated",
|
|
107
|
+
"passCriteria": "Code comments, README updates, API documentation, and inline documentation reflect all changes",
|
|
108
|
+
"weight": "warning",
|
|
109
|
+
"category": "documentation"
|
|
110
|
+
},
|
|
111
|
+
{
|
|
112
|
+
"step": 16,
|
|
113
|
+
"description": "Verify performance considerations",
|
|
114
|
+
"passCriteria": "No obvious performance regressions, efficient algorithms used, proper resource management, and performance tests where applicable",
|
|
115
|
+
"weight": "warning",
|
|
116
|
+
"category": "performance"
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
"step": 17,
|
|
120
|
+
"description": "Validate evidence document exists",
|
|
121
|
+
"command": "find \"docs/evidence\" -name \"*{issue_number}*implementation*\" -type f",
|
|
122
|
+
"passCriteria": "Implementation evidence document exists with test results, validation details, and proof of all requirements being met",
|
|
123
|
+
"weight": "warning",
|
|
124
|
+
"category": "documentation"
|
|
125
|
+
}
|
|
126
|
+
],
|
|
127
|
+
"gradingCriteria": {
|
|
128
|
+
"passRequirements": [
|
|
129
|
+
"ALL blocking validation steps must pass",
|
|
130
|
+
"At least 80% of warning validation steps should pass",
|
|
131
|
+
"All design aspects are fully implemented",
|
|
132
|
+
"All test cases from design document are written and passing",
|
|
133
|
+
"Tests follow architecture standards and test real functionality",
|
|
134
|
+
"No tests mock objects under test or default to passing",
|
|
135
|
+
"Tests use flow testing to validate runtime behavior",
|
|
136
|
+
"Code is production-ready and maintainable"
|
|
137
|
+
],
|
|
138
|
+
"failRequirements": [
|
|
139
|
+
"ANY blocking validation step fails",
|
|
140
|
+
"Design implementation is incomplete",
|
|
141
|
+
"Test cases from design document are missing",
|
|
142
|
+
"Tests violate architecture standards",
|
|
143
|
+
"Tests mock the objects they should be testing",
|
|
144
|
+
"Tests default to passing without proper validation",
|
|
145
|
+
"Tests rely on static analysis instead of flow testing",
|
|
146
|
+
"Code has obvious bugs or security issues"
|
|
147
|
+
]
|
|
148
|
+
},
|
|
149
|
+
"reportingFormat": {
|
|
150
|
+
"requiredFields": ["pass", "reasons"],
|
|
151
|
+
"instructions": "Evaluate each validation step rigorously. Pay special attention to test quality - verify that tests actually test the intended functionality and follow architecture standards. If ANY blocking step fails, you must report pass=false. Focus on design completeness, test quality, and production readiness."
|
|
152
|
+
}
|
|
153
|
+
}
|
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# Phase: Retrospective
|
|
2
|
+
|
|
3
|
+
## INTENT
|
|
4
|
+
To conduct a comprehensive retrospective of the completed work while full context is available, capturing learnings and insights before branch cleanup and resolution. This phase applies to all workflow types (spec, design, implement, test).
|
|
5
|
+
|
|
6
|
+
## TRIGGER
|
|
7
|
+
This phase is triggered after PR approval (`wait-for-pr-review` completion) and before `resolve` phase for all workflow types.
|
|
8
|
+
|
|
9
|
+
## CONTEXT ADVANTAGES
|
|
10
|
+
- **Full Work Context**: All changes, decisions, and challenges are fresh in memory
|
|
11
|
+
- **Branch Available**: Can reference specific commits, diffs, and work artifacts
|
|
12
|
+
- **Problem-Solution Mapping**: Clear connection between original problem and completed solution
|
|
13
|
+
- **Fresh Insights**: Recent experience provides accurate reflection on what worked/didn't work
|
|
14
|
+
- **PR Feedback Available**: Can analyze and learn from user feedback received during review
|
|
15
|
+
- **Complete Journey**: Can analyze entire workflow from start to finish
|
|
16
|
+
|
|
17
|
+
## WORKFLOW
|
|
18
|
+
|
|
19
|
+
### Step 1: Retrospective Preparation
|
|
20
|
+
- Ensure PR is approved and ready for merge
|
|
21
|
+
- Gather work artifacts (commits, documents, test results, etc.)
|
|
22
|
+
- Review original issue requirements and acceptance criteria
|
|
23
|
+
- **Collect PR feedback**: Review all comments, suggestions, and feedback received during PR review
|
|
24
|
+
- Analyze user feedback patterns and themes
|
|
25
|
+
- Identify key decision points and challenges encountered
|
|
26
|
+
|
|
27
|
+
### Step 2: Create Retrospective Document
|
|
28
|
+
- Create (or use existing) retrospective file: `retrospectives/issue-{issue-number}-{kebab-title}-postmortem.md`
|
|
29
|
+
- Use retrospective template: `get_fraim_file({ path: "templates/retrospective/RETROSPECTIVE-TEMPLATE.md" })`
|
|
30
|
+
- Document while work context is fresh and complete
|
|
31
|
+
|
|
32
|
+
### Step 3: Work Analysis
|
|
33
|
+
- **What Went Well**: Successful approaches, tools, and techniques used
|
|
34
|
+
- **What Went Poorly**: Challenges, obstacles, and inefficiencies encountered
|
|
35
|
+
- **Root Cause Analysis**: Why problems occurred, not just what happened
|
|
36
|
+
- **Decision Analysis**: Review key decisions made during the work
|
|
37
|
+
- **PR Feedback Analysis**: What user feedback revealed about the work quality
|
|
38
|
+
- **Process Effectiveness**: How well the workflow supported the work
|
|
39
|
+
|
|
40
|
+
### Step 4: Learning Extraction
|
|
41
|
+
- **Key Learnings**: Specific insights that can help future work of this type
|
|
42
|
+
- **Process Improvements**: Workflow or rule changes that would help
|
|
43
|
+
- **Tool/Technique Discoveries**: New approaches or tools that proved valuable
|
|
44
|
+
- **Anti-Patterns Identified**: Approaches to avoid in future work
|
|
45
|
+
- **User Feedback Patterns**: Common themes in user feedback to address
|
|
46
|
+
- **Quality Insights**: What contributed to or detracted from work quality
|
|
47
|
+
|
|
48
|
+
### Step 5: Prevention Measures
|
|
49
|
+
- **Specific Actions**: Concrete steps to prevent similar issues in future work
|
|
50
|
+
- **Rule Updates**: Suggestions for updating FRAIM rules or workflows
|
|
51
|
+
- **Knowledge Sharing**: Insights that should be shared with other agents
|
|
52
|
+
- **Process Enhancements**: Workflow improvements based on experience
|
|
53
|
+
- **Feedback Integration**: How to better incorporate user feedback in future work
|
|
54
|
+
- **Quality Improvements**: Changes to improve work quality
|
|
55
|
+
|
|
56
|
+
### Step 6: Validation and Completion
|
|
57
|
+
- Ensure retrospective meets quality criteria
|
|
58
|
+
- Validate all template sections are complete
|
|
59
|
+
- Confirm learnings are actionable and specific
|
|
60
|
+
- Verify PR feedback has been analyzed and learned from
|
|
61
|
+
- Check that prevention measures are concrete and implementable
|
|
62
|
+
- Mark phase complete and proceed to resolve
|
|
63
|
+
|
|
64
|
+
## VALIDATION CRITERIA
|
|
65
|
+
- ✅ Retrospective document created using template
|
|
66
|
+
- ✅ Root cause analysis completed (not just symptoms)
|
|
67
|
+
- ✅ Prevention measures documented and actionable
|
|
68
|
+
- ✅ Key learnings extracted and documented
|
|
69
|
+
- ✅ Process improvements identified
|
|
70
|
+
- ✅ PR feedback analyzed and lessons captured
|
|
71
|
+
- ✅ All template sections completed with substantial content
|
|
72
|
+
- ✅ Retrospective quality meets standards
|
|
73
|
+
- ✅ Learnings are specific to the workflow type and transferable
|
|
74
|
+
|
|
75
|
+
## PHASE COMPLETION
|
|
76
|
+
This phase is complete when:
|
|
77
|
+
1. Comprehensive retrospective document is created
|
|
78
|
+
2. All validation criteria are met
|
|
79
|
+
3. Learnings are documented for future reference
|
|
80
|
+
4. PR feedback has been systematically analyzed
|
|
81
|
+
5. Prevention measures are specific and actionable
|
|
82
|
+
6. Process improvements are identified
|
|
83
|
+
7. Agent is ready to proceed to resolve phase
|
|
84
|
+
|
|
85
|
+
## WORKFLOW-SPECIFIC FOCUS AREAS
|
|
86
|
+
|
|
87
|
+
### Spec Retrospective Focus
|
|
88
|
+
- Requirements gathering effectiveness
|
|
89
|
+
- Stakeholder engagement quality
|
|
90
|
+
- Competitive analysis thoroughness
|
|
91
|
+
- User experience definition clarity
|
|
92
|
+
- Validation plan completeness
|
|
93
|
+
|
|
94
|
+
### Design Retrospective Focus
|
|
95
|
+
- Technical decision quality
|
|
96
|
+
- Architecture choice rationale
|
|
97
|
+
- Design review feedback incorporation
|
|
98
|
+
- Technical feasibility assessment
|
|
99
|
+
- Implementation guidance clarity
|
|
100
|
+
|
|
101
|
+
### Implement Retrospective Focus
|
|
102
|
+
- Code quality and maintainability
|
|
103
|
+
- Technical approach effectiveness
|
|
104
|
+
- Testing strategy success
|
|
105
|
+
- Performance considerations
|
|
106
|
+
- Integration challenges
|
|
107
|
+
|
|
108
|
+
### Test Retrospective Focus
|
|
109
|
+
- Test coverage adequacy
|
|
110
|
+
- Quality assurance approach effectiveness
|
|
111
|
+
- Testing strategy validation
|
|
112
|
+
- Bug detection capability
|
|
113
|
+
- Test maintenance considerations
|
|
114
|
+
|
|
115
|
+
## NEXT PHASE
|
|
116
|
+
After completing retrospective, proceed to `resolve` phase for final merge and cleanup.
|
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
# Phase: address-pr-feedback
|
|
2
|
+
|
|
3
|
+
## INTENT
|
|
4
|
+
To systematically address all PR feedback items by making targeted changes, replying to comments, and preparing for re-validation.
|
|
5
|
+
|
|
6
|
+
## OUTCOME
|
|
7
|
+
All PR feedback addressed with:
|
|
8
|
+
- Targeted changes made for each feedback item
|
|
9
|
+
- Feedback file updated with resolutions
|
|
10
|
+
- PR comments replied to with explanations
|
|
11
|
+
- Changes validated and ready for re-review
|
|
12
|
+
|
|
13
|
+
## RULES FOR THIS PHASE
|
|
14
|
+
|
|
15
|
+
### Success Criteria
|
|
16
|
+
Read `registry/rules/agent-success-criteria.md` via `get_fraim_file` for the complete framework. Focus especially on:
|
|
17
|
+
- **Integrity** (document all changes made)
|
|
18
|
+
- **Correctness** (address feedback accurately)
|
|
19
|
+
- **Completeness** (address every UNADDRESSED item)
|
|
20
|
+
|
|
21
|
+
### Simplicity Principles
|
|
22
|
+
Read `registry/rules/simplicity.md` via `get_fraim_file` for complete guidelines. Critical for feedback phase:
|
|
23
|
+
- **Targeted Changes**: Make minimal changes to address specific feedback
|
|
24
|
+
- **Manual Validation**: Test changes manually before updating PR
|
|
25
|
+
- **Clear Communication**: Reply to each comment with clear explanations
|
|
26
|
+
|
|
27
|
+
## PRINCIPLES
|
|
28
|
+
- **Feedback-Driven**: Address only the specific issues raised in PR comments
|
|
29
|
+
- **Minimal Changes**: Avoid scope creep or unnecessary refactoring
|
|
30
|
+
- **Clear Communication**: Explain resolutions clearly to reviewers
|
|
31
|
+
- **Validation**: Ensure changes work before updating PR
|
|
32
|
+
|
|
33
|
+
## 📋 WORKFLOW
|
|
34
|
+
|
|
35
|
+
### Step 1: Read PR Feedback File
|
|
36
|
+
|
|
37
|
+
**MANDATORY**: Read the feedback file created by `wait-for-pr-review`:
|
|
38
|
+
- File location: `docs/evidence/{issue_number}-{workflow_type}-feedback.md`
|
|
39
|
+
- Identify all UNADDRESSED feedback items
|
|
40
|
+
- Understand the context and requirements for each item
|
|
41
|
+
|
|
42
|
+
### Step 2: Address Each Feedback Item
|
|
43
|
+
|
|
44
|
+
**For each UNADDRESSED item:**
|
|
45
|
+
|
|
46
|
+
1. **Understand the Feedback**:
|
|
47
|
+
- Read the comment carefully
|
|
48
|
+
- Identify what specific change is requested
|
|
49
|
+
- Determine the scope of the change needed
|
|
50
|
+
|
|
51
|
+
2. **Make Targeted Changes**:
|
|
52
|
+
- Make minimal, focused changes to address the specific feedback
|
|
53
|
+
- Avoid unrelated changes or improvements
|
|
54
|
+
- Keep changes as small as possible while fully addressing the feedback
|
|
55
|
+
|
|
56
|
+
3. **Update Feedback File**:
|
|
57
|
+
- Change status from UNADDRESSED to ADDRESSED
|
|
58
|
+
- Document your resolution approach
|
|
59
|
+
- Include details of what you changed
|
|
60
|
+
|
|
61
|
+
**Feedback File Update Format**:
|
|
62
|
+
```markdown
|
|
63
|
+
### Comment X - ADDRESSED
|
|
64
|
+
- **Author**: reviewer_name
|
|
65
|
+
- **Type**: pr_comment|review_comment|review
|
|
66
|
+
- **File**: file_path (if applicable)
|
|
67
|
+
- **Line**: line_number (if applicable)
|
|
68
|
+
- **Comment**: Original feedback text
|
|
69
|
+
- **Status**: ADDRESSED
|
|
70
|
+
- **Resolution**: Detailed explanation of how you addressed this feedback
|
|
71
|
+
- **Changes Made**: Specific files/lines modified
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Step 3: Validate Changes
|
|
75
|
+
|
|
76
|
+
**Test your changes:**
|
|
77
|
+
- Run compilation check: `npx tsc --noEmit --skipLibCheck`
|
|
78
|
+
- Run relevant tests to ensure no regressions
|
|
79
|
+
- Test manually if the feedback involves UI/API behavior
|
|
80
|
+
- Verify the specific issue mentioned in feedback is resolved
|
|
81
|
+
|
|
82
|
+
### Step 4: Reply to PR Comments
|
|
83
|
+
|
|
84
|
+
**For each addressed comment:**
|
|
85
|
+
- Reply to the original PR comment
|
|
86
|
+
- Explain what you changed and how it addresses their concern
|
|
87
|
+
- Reference specific files/lines if helpful
|
|
88
|
+
- Be clear and professional in your communication
|
|
89
|
+
|
|
90
|
+
**Example reply format**:
|
|
91
|
+
```
|
|
92
|
+
✅ **Addressed**: [Brief description of what you changed]
|
|
93
|
+
|
|
94
|
+
**Changes made**:
|
|
95
|
+
- [Specific change 1]
|
|
96
|
+
- [Specific change 2]
|
|
97
|
+
|
|
98
|
+
**Files modified**: `path/to/file.ts`, `path/to/test.ts`
|
|
99
|
+
|
|
100
|
+
This should resolve the [specific issue mentioned]. Please let me know if you need any clarification!
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### Step 5: Commit and Push Changes
|
|
104
|
+
|
|
105
|
+
**Commit your changes:**
|
|
106
|
+
- Use clear commit messages that reference the feedback
|
|
107
|
+
- Example: `Address PR feedback: Fix error handling in auth service`
|
|
108
|
+
- Push changes to the PR branch
|
|
109
|
+
|
|
110
|
+
## 📸 EVIDENCE REQUIREMENTS
|
|
111
|
+
|
|
112
|
+
You MUST provide concrete evidence for all claims:
|
|
113
|
+
|
|
114
|
+
1. **All Feedback Addressed**: Every UNADDRESSED item in feedback file is now ADDRESSED
|
|
115
|
+
2. **Changes Made**: Specific code changes made for each feedback item
|
|
116
|
+
3. **Validation Complete**: Tests pass and changes work as expected
|
|
117
|
+
4. **PR Updated**: Changes committed, pushed, and comments replied to
|
|
118
|
+
|
|
119
|
+
## VALIDATION
|
|
120
|
+
|
|
121
|
+
### Phase Complete When:
|
|
122
|
+
- ✅ All UNADDRESSED items in feedback file are now ADDRESSED
|
|
123
|
+
- ✅ Feedback file updated with resolution details for each item
|
|
124
|
+
- ✅ Targeted changes made to address each specific feedback
|
|
125
|
+
- ✅ Changes validated (compilation, tests, manual testing)
|
|
126
|
+
- ✅ PR comments replied to with clear explanations
|
|
127
|
+
- ✅ Changes committed and pushed to PR branch
|
|
128
|
+
|
|
129
|
+
### Phase Incomplete If:
|
|
130
|
+
- ❌ Any UNADDRESSED items remain in feedback file
|
|
131
|
+
- ❌ Changes don't actually address the feedback given
|
|
132
|
+
- ❌ Tests failing after changes
|
|
133
|
+
- ❌ Compilation errors introduced
|
|
134
|
+
- ❌ PR comments not replied to
|
|
135
|
+
- ❌ Changes not committed/pushed
|
|
136
|
+
|
|
137
|
+
### Report Back:
|
|
138
|
+
When you complete this phase, call:
|
|
139
|
+
|
|
140
|
+
```javascript
|
|
141
|
+
seekMentoring({
|
|
142
|
+
workflowType: "{workflow_type}",
|
|
143
|
+
issueNumber: "{issue_number}",
|
|
144
|
+
currentPhase: "address-pr-feedback",
|
|
145
|
+
status: "complete",
|
|
146
|
+
findings: {
|
|
147
|
+
feedbackItemsAddressed: {total_items_addressed},
|
|
148
|
+
changesValidated: true
|
|
149
|
+
},
|
|
150
|
+
evidence: {
|
|
151
|
+
feedbackFileUpdated: "All UNADDRESSED items now ADDRESSED with resolutions",
|
|
152
|
+
changesMade: "Brief summary of changes made",
|
|
153
|
+
validationResults: "Compilation and tests pass",
|
|
154
|
+
prCommentsReplied: "Replied to all PR comments with explanations"
|
|
155
|
+
}
|
|
156
|
+
})
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
If feedback addressing incomplete, iterate:
|
|
160
|
+
```javascript
|
|
161
|
+
seekMentoring({
|
|
162
|
+
workflowType: "{workflow_type}",
|
|
163
|
+
issueNumber: "{issue_number}",
|
|
164
|
+
currentPhase: "address-pr-feedback",
|
|
165
|
+
status: "incomplete",
|
|
166
|
+
findings: {
|
|
167
|
+
uncertainties: ["Issues encountered", "What needs to be fixed"]
|
|
168
|
+
}
|
|
169
|
+
})
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
## SCRIPTS
|
|
173
|
+
|
|
174
|
+
**Compile TypeScript:**
|
|
175
|
+
```bash
|
|
176
|
+
npx tsc --noEmit --skipLibCheck
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
**Run tests:**
|
|
180
|
+
```bash
|
|
181
|
+
npm test
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
**Check git status:**
|
|
185
|
+
```bash
|
|
186
|
+
git status
|
|
187
|
+
git diff
|
|
188
|
+
```
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# Phase: Finalize
|
|
2
|
+
|
|
3
|
+
## INTENT
|
|
4
|
+
To prepare completed work for human review by setting proper labels, creating/updating PR, and documenting evidence.
|
|
5
|
+
|
|
6
|
+
## OUTCOME
|
|
7
|
+
Work is ready for human review with:
|
|
8
|
+
- Proper issue labels applied
|
|
9
|
+
- PR created/updated with work
|
|
10
|
+
- Evidence documented
|
|
11
|
+
- Clean handoff to next phase or review
|
|
12
|
+
|
|
13
|
+
## PRINCIPLES
|
|
14
|
+
- **Complete Documentation**: Evidence shows all work done
|
|
15
|
+
- **Proper Labels**: Issue status reflects readiness
|
|
16
|
+
- **Clear Communication**: PR and evidence are clear
|
|
17
|
+
- **Ready for Review**: No blockers for human reviewer
|
|
18
|
+
|
|
19
|
+
## RULES FOR THIS PHASE
|
|
20
|
+
|
|
21
|
+
### Success Criteria
|
|
22
|
+
Read `registry/rules/agent-success-criteria.md` via `get_fraim_file` for the complete framework. Focus on:
|
|
23
|
+
- **Integrity** (honest documentation of all work completed)
|
|
24
|
+
- **Completeness** (all finalization steps completed)
|
|
25
|
+
|
|
26
|
+
### Simplicity Principles
|
|
27
|
+
Read `registry/rules/simplicity.md` via `get_fraim_file` for complete guidelines. Key for finalization:
|
|
28
|
+
- **Focus on the assigned issue only** - document only relevant work
|
|
29
|
+
- **Clear communication** - evidence should be easy to understand
|
|
30
|
+
|
|
31
|
+
### Git Operations (if needed)
|
|
32
|
+
When using git commands directly (if MCP tools unavailable), read `registry/rules/git-safe-commands.md` via `get_fraim_file` to avoid interactive commands that hang agents.
|
|
33
|
+
|
|
34
|
+
## WORKFLOW
|
|
35
|
+
|
|
36
|
+
### Step 1: Update Issue Labels
|
|
37
|
+
|
|
38
|
+
**Remove:**
|
|
39
|
+
- `status:wip`
|
|
40
|
+
- Any phase-specific labels (e.g., `phase:spec`, `phase:design`, `phase:impl`)
|
|
41
|
+
|
|
42
|
+
**Add:**
|
|
43
|
+
- `status:needs-review`
|
|
44
|
+
|
|
45
|
+
**GitHub Repository Context:**
|
|
46
|
+
Read `.fraim/config.json` for:
|
|
47
|
+
- `git.repoOwner` - GitHub repository owner
|
|
48
|
+
- `git.repoName` - GitHub repository name
|
|
49
|
+
|
|
50
|
+
Use GitHub MCP tools to update labels.
|
|
51
|
+
|
|
52
|
+
### Step 2: Create Evidence Document
|
|
53
|
+
|
|
54
|
+
**File location:**
|
|
55
|
+
```
|
|
56
|
+
docs/evidence/{issue_number}-{workflow_type}-evidence.md
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
**Evidence document should include:**
|
|
60
|
+
|
|
61
|
+
#### Summary
|
|
62
|
+
- Issue number and title
|
|
63
|
+
- Workflow type (spec, design, implement, test)
|
|
64
|
+
- Brief description of work completed
|
|
65
|
+
|
|
66
|
+
#### Work Completed
|
|
67
|
+
**For Spec Workflow:**
|
|
68
|
+
- Specification document created
|
|
69
|
+
- High-fidelity HTML mocks (if UI changes)
|
|
70
|
+
- Requirements coverage
|
|
71
|
+
|
|
72
|
+
**For Design Workflow:**
|
|
73
|
+
- Technical design document
|
|
74
|
+
- Architecture decisions
|
|
75
|
+
- API specifications
|
|
76
|
+
- Database schema (if applicable)
|
|
77
|
+
|
|
78
|
+
**For Implement Workflow:**
|
|
79
|
+
- Implementation details
|
|
80
|
+
- Key files changed
|
|
81
|
+
- Approach taken
|
|
82
|
+
- Testing completed
|
|
83
|
+
|
|
84
|
+
**For Test Workflow:**
|
|
85
|
+
- Test suite created/enhanced
|
|
86
|
+
- Coverage metrics
|
|
87
|
+
- Test results
|
|
88
|
+
|
|
89
|
+
#### Validation
|
|
90
|
+
- How work was validated
|
|
91
|
+
- Validation results
|
|
92
|
+
- Screenshots/output (if applicable)
|
|
93
|
+
|
|
94
|
+
#### Quality Checks
|
|
95
|
+
- All deliverables complete
|
|
96
|
+
- Documentation clear and professional
|
|
97
|
+
- Work ready for next phase or review
|
|
98
|
+
|
|
99
|
+
#### Phase Completion
|
|
100
|
+
- All phases completed for this workflow
|
|
101
|
+
- Evidence from each phase
|
|
102
|
+
- Any iterations or challenges
|
|
103
|
+
|
|
104
|
+
### Step 3: Verify PR Exists
|
|
105
|
+
|
|
106
|
+
**Verify PR:**
|
|
107
|
+
- PR exists for the feature branch
|
|
108
|
+
- PR title reflects the issue and workflow
|
|
109
|
+
- PR description includes context and links to deliverables
|
|
110
|
+
|
|
111
|
+
**If PR doesn't exist:**
|
|
112
|
+
- Create PR manually
|
|
113
|
+
- Link to issue
|
|
114
|
+
- Add evidence document link
|
|
115
|
+
|
|
116
|
+
### Step 4: Add PR Comment
|
|
117
|
+
|
|
118
|
+
Add comment to PR with link to evidence:
|
|
119
|
+
```
|
|
120
|
+
{Workflow_type} workflow complete. Evidence document: docs/evidence/{issue_number}-{workflow_type}-evidence.md
|
|
121
|
+
|
|
122
|
+
All phases completed:
|
|
123
|
+
{workflow_specific_phases_checklist}
|
|
124
|
+
|
|
125
|
+
Ready for human review.
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Step 5: Final Verification
|
|
129
|
+
|
|
130
|
+
**Checklist:**
|
|
131
|
+
- ✅ Issue labels updated
|
|
132
|
+
- ✅ Evidence document created and complete
|
|
133
|
+
- ✅ PR exists and is ready
|
|
134
|
+
- ✅ PR comment added with evidence link
|
|
135
|
+
- ✅ All deliverables complete
|
|
136
|
+
- ✅ Git status clean
|
|
137
|
+
|
|
138
|
+
## VALIDATION
|
|
139
|
+
|
|
140
|
+
### Phase Complete When:
|
|
141
|
+
- ✅ Issue has `status:needs-review` label
|
|
142
|
+
- ✅ Issue does not have workflow phase labels
|
|
143
|
+
- ✅ Evidence document exists and is complete
|
|
144
|
+
- ✅ PR exists and is ready for review
|
|
145
|
+
- ✅ PR has comment linking to evidence
|
|
146
|
+
- ✅ All previous phases complete
|
|
147
|
+
|
|
148
|
+
### Phase Incomplete If:
|
|
149
|
+
- ❌ Labels not updated
|
|
150
|
+
- ❌ Evidence document missing or incomplete
|
|
151
|
+
- ❌ PR not ready
|
|
152
|
+
- ❌ Previous phases not complete
|
|
153
|
+
|
|
154
|
+
### Report Back:
|
|
155
|
+
```javascript
|
|
156
|
+
seekCoachingOnNextStep({
|
|
157
|
+
workflowType: "{workflow_type}",
|
|
158
|
+
issueNumber: "{issue_number}",
|
|
159
|
+
currentPhase: "finalize",
|
|
160
|
+
status: "complete",
|
|
161
|
+
evidence: {
|
|
162
|
+
labelsUpdated: "Issue has status:needs-review label",
|
|
163
|
+
evidenceDocument: "docs/evidence/{issue_number}-{workflow_type}-evidence.md created",
|
|
164
|
+
prStatus: "PR ready for review",
|
|
165
|
+
prComment: "PR comment added with evidence link",
|
|
166
|
+
allPhasesComplete: "All {workflow_type} phases completed successfully"
|
|
167
|
+
}
|
|
168
|
+
})
|
|
169
|
+
```
|