@intentsolutionsio/sprint 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/.claude-plugin/plugin.json +23 -0
  2. package/LICENSE +21 -0
  3. package/README.md +320 -0
  4. package/agents/allpurpose-agent.md +159 -0
  5. package/agents/cicd-agent.md +189 -0
  6. package/agents/nextjs-dev.md +204 -0
  7. package/agents/nextjs-diagnostics-agent.md +206 -0
  8. package/agents/project-architect.md +398 -0
  9. package/agents/python-dev.md +159 -0
  10. package/agents/qa-test-agent.md +192 -0
  11. package/agents/ui-test-agent.md +295 -0
  12. package/agents/website-designer.md +48 -0
  13. package/commands/clean.md +153 -0
  14. package/commands/generate-map.md +160 -0
  15. package/commands/new.md +173 -0
  16. package/commands/setup.md +239 -0
  17. package/commands/sprint.md +482 -0
  18. package/commands/test.md +183 -0
  19. package/package.json +44 -0
  20. package/skills/agent-patterns/SKILL.md +103 -0
  21. package/skills/agent-patterns/references/errors.md +8 -0
  22. package/skills/agent-patterns/references/examples.md +291 -0
  23. package/skills/agent-patterns/references/ui-test-report.md +35 -0
  24. package/skills/api-contract/SKILL.md +115 -0
  25. package/skills/api-contract/references/best-practices.md +47 -0
  26. package/skills/api-contract/references/errors.md +8 -0
  27. package/skills/api-contract/references/examples.md +448 -0
  28. package/skills/api-contract/references/pagination.md +46 -0
  29. package/skills/api-contract/references/typescript-interfaces.md +46 -0
  30. package/skills/api-contract/references/writing-endpoints.md +45 -0
  31. package/skills/spec-writing/SKILL.md +110 -0
  32. package/skills/spec-writing/references/errors.md +8 -0
  33. package/skills/spec-writing/references/examples.md +274 -0
  34. package/skills/spec-writing/references/testing-configuration.md +40 -0
  35. package/skills/sprint-workflow/SKILL.md +81 -0
  36. package/skills/sprint-workflow/references/errors.md +8 -0
  37. package/skills/sprint-workflow/references/examples.md +317 -0
  38. package/skills/sprint-workflow/references/sprint-phases.md +54 -0
@@ -0,0 +1,274 @@
1
+ # Examples
2
+
3
+ ## Example 1: Minimal Backend API Spec
4
+
5
+ A focused spec for a single-domain API with clear scope boundaries and
6
+ mandatory QA testing.
7
+
8
+ ```markdown
9
+ # Sprint 1: Authentication API
10
+
11
+ ## Goal
12
+ Add email/password authentication with JWT tokens and refresh token rotation.
13
+
14
+ ## Scope
15
+ ### In Scope
16
+ - POST /auth/register (email + password, validate format)
17
+ - POST /auth/login (return access + refresh tokens)
18
+ - POST /auth/refresh (rotate refresh token, issue new access token)
19
+ - POST /auth/logout (invalidate refresh token)
20
+ - Password hashing with bcrypt (min 10 rounds)
21
+ - JWT access token (15min expiry, HS256)
22
+ - Refresh token stored in database (7-day expiry)
23
+
24
+ ### Out of Scope
25
+ - OAuth providers (Google, GitHub, Apple)
26
+ - Password reset flow
27
+ - Email verification
28
+ - Rate limiting (separate sprint)
29
+ - Admin user management
30
+
31
+ ## Testing
32
+ - QA: required
33
+ - UI Testing: skip
34
+ - UI Testing Mode: automated
35
+ ```
36
+
37
+ **Why this works:**
38
+ - Goal is one sentence describing the deliverable
39
+ - In Scope lists every endpoint with its behavior
40
+ - Out of Scope prevents agent drift toward OAuth or email flows
41
+ - QA is required (API endpoints need automated tests)
42
+ - UI Testing is skipped (no frontend changes)
43
+
44
+ ## Example 2: Frontend-Only Spec with Manual UI Testing
45
+
46
+ A spec for visual UI changes where automated E2E tests cannot easily
47
+ verify the result and manual inspection is needed.
48
+
49
+ ```markdown
50
+ # Sprint 5: Dark Mode Support
51
+
52
+ ## Goal
53
+ Add dark mode with system preference detection and manual toggle.
54
+
55
+ ## Scope
56
+ ### In Scope
57
+ - CSS custom properties for all color tokens (light and dark variants)
58
+ - Dark mode toggle button in the header nav
59
+ - System preference detection via prefers-color-scheme media query
60
+ - Persist user preference in localStorage
61
+ - Smooth transition animation between themes (200ms)
62
+ - Update all existing components to use color tokens instead of hardcoded values
63
+
64
+ ### Out of Scope
65
+ - New components or layouts
66
+ - API changes
67
+ - Database changes
68
+ - Third-party theme libraries
69
+
70
+ ## Testing
71
+ - QA: skip
72
+ - UI Testing: required
73
+ - UI Testing Mode: manual
74
+ ```
75
+
76
+ **Why manual testing is appropriate here:**
77
+ - Visual correctness (contrast, readability) requires human eyes
78
+ - Theme transitions need subjective quality assessment
79
+ - System preference detection needs OS-level interaction
80
+ - QA is skipped because there are no API or logic changes
81
+
82
+ ## Example 3: Full-Stack Feature Spec
83
+
84
+ A spec covering both backend and frontend work with parallel agent execution
85
+ and both QA and automated UI testing.
86
+
87
+ ```markdown
88
+ # Sprint 3: Product Search
89
+
90
+ ## Goal
91
+ Full-text product search with type-ahead suggestions and faceted filtering.
92
+
93
+ ## Scope
94
+ ### In Scope
95
+ - **Backend:**
96
+ - POST /api/search (full-text query with filters, pagination)
97
+ - GET /api/search/facets (available filter options with counts)
98
+ - Elasticsearch integration for indexing and querying
99
+ - Product indexing triggered on create/update/delete
100
+ - **Frontend:**
101
+ - Search bar with debounced type-ahead (300ms)
102
+ - Facet sidebar with checkbox filters (category, price range, rating)
103
+ - Search results grid with pagination (20 items per page)
104
+ - Empty state when no results match
105
+ - Loading skeleton during search execution
106
+ - **Shared:**
107
+ - SearchRequest and SearchResponse TypeScript interfaces
108
+ - FacetGroup type definition for filter categories
109
+
110
+ ### Out of Scope
111
+ - Search analytics or query logging
112
+ - Saved searches or search history
113
+ - Autocomplete from external suggestion APIs
114
+ - Image search or visual similarity
115
+ - Search result caching (handle in a performance sprint)
116
+
117
+ ## Testing
118
+ - QA: required
119
+ - UI Testing: required
120
+ - UI Testing Mode: automated
121
+ ```
122
+
123
+ **Why this works:**
124
+ - Scope is partitioned by domain (Backend / Frontend / Shared)
125
+ - Each agent gets a clear boundary
126
+ - Shared types are called out so both agents reference the same contract
127
+ - Both QA and UI testing are required (backend logic + frontend interactions)
128
+
129
+ ## Example 4: Iterative Spec After First Iteration
130
+
131
+ A spec that has been narrowed based on iteration 1 results. Completed items
132
+ are removed and only remaining work and fixes are listed.
133
+
134
+ **Original specs.md (before sprint):**
135
+ ```markdown
136
+ # Sprint 2: User Dashboard
137
+
138
+ ## Goal
139
+ Build a user dashboard showing recent activity, notifications, and account settings.
140
+
141
+ ## Scope
142
+ ### In Scope
143
+ - Activity feed (last 30 days, paginated)
144
+ - Notification center (unread count badge, mark-as-read)
145
+ - Account settings page (name, email, avatar upload)
146
+ - Responsive layout (mobile, tablet, desktop)
147
+
148
+ ### Out of Scope
149
+ - Admin dashboard
150
+ - Real-time WebSocket updates
151
+ - Email notification preferences
152
+
153
+ ## Testing
154
+ - QA: required
155
+ - UI Testing: required
156
+ - UI Testing Mode: automated
157
+ ```
158
+
159
+ **Updated specs.md (after iteration 1, 2 items remaining):**
160
+ ```markdown
161
+ # Sprint 2: User Dashboard (Iteration 2)
162
+
163
+ ## Goal
164
+ Fix remaining issues from iteration 1.
165
+
166
+ ## Scope
167
+ ### In Scope
168
+ - **Fix: Notification mark-as-read** — PATCH /api/notifications/:id returns 500
169
+ when notification is already read. Should return 200 with no-op behavior.
170
+ - **Fix: Avatar upload** — Upload succeeds but the avatar URL in the profile
171
+ response still shows the old URL. Cache invalidation missing after upload.
172
+
173
+ ### Completed (DO NOT re-implement)
174
+ - Activity feed: working, 12/12 tests passing
175
+ - Notification listing + unread count: working, 8/8 tests passing
176
+ - Account settings (name, email): working, 6/6 tests passing
177
+ - Responsive layout: all breakpoints verified
178
+
179
+ ### Out of Scope
180
+ - Same as iteration 1
181
+
182
+ ## Testing
183
+ - QA: required
184
+ - UI Testing: required
185
+ - UI Testing Mode: automated
186
+ ```
187
+
188
+ **Why iterative narrowing matters:**
189
+ - Removes completed work so agents do not re-implement it
190
+ - Explicitly describes the two bugs with expected vs actual behavior
191
+ - "Completed" section tells agents what NOT to touch
192
+ - Iteration converges faster because scope shrinks each round
193
+
194
+ ## Example 5: Infrastructure Sprint (No UI Testing)
195
+
196
+ A spec for DevOps/infrastructure work that needs automated validation
197
+ but has no user-facing UI.
198
+
199
+ ```markdown
200
+ # Sprint 7: CI/CD Pipeline
201
+
202
+ ## Goal
203
+ Automated build, test, and deploy pipeline with staging and production environments.
204
+
205
+ ## Scope
206
+ ### In Scope
207
+ - GitHub Actions workflow: lint → test → build → deploy
208
+ - Docker multi-stage build (builder + runtime stages)
209
+ - Staging environment deployment on push to develop branch
210
+ - Production deployment on push to main branch (manual approval gate)
211
+ - Environment-specific secrets via GitHub Secrets
212
+ - Deployment health check (HTTP 200 on /health within 60 seconds)
213
+ - Rollback procedure documented in DEPLOYMENT.md
214
+
215
+ ### Out of Scope
216
+ - Monitoring and alerting setup
217
+ - Log aggregation
218
+ - Performance testing
219
+ - CDN configuration
220
+ - Database migration automation
221
+
222
+ ## Testing
223
+ - QA: required
224
+ - UI Testing: skip
225
+ - UI Testing Mode: automated
226
+ ```
227
+
228
+ ## Example 6: Spec with Specific Technical Constraints
229
+
230
+ When the spec must dictate implementation choices to ensure consistency
231
+ with existing architecture.
232
+
233
+ ```markdown
234
+ # Sprint 8: WebSocket Real-Time Chat
235
+
236
+ ## Goal
237
+ Real-time chat for project collaboration with channel support and presence tracking.
238
+
239
+ ## Scope
240
+ ### In Scope
241
+ - WebSocket server using Socket.io v4 (must match existing ws infra)
242
+ - Channel join/leave with presence indicators
243
+ - Message broadcasting within channels
244
+ - Message persistence to PostgreSQL via existing Drizzle ORM setup
245
+ - Typing indicator (show "user is typing..." for 3 seconds after last keystroke)
246
+ - Message delivery confirmation (sent → delivered → read receipts)
247
+ - Reconnection with message backfill (last 50 messages on rejoin)
248
+
249
+ ### Out of Scope
250
+ - File attachments in messages
251
+ - Message reactions or threads
252
+ - Voice/video calls
253
+ - Push notifications to mobile
254
+ - Message search
255
+
256
+ ## Technical Constraints
257
+ - Must use Socket.io v4 (not raw WebSockets or alternatives like Pusher)
258
+ - Must use existing PostgreSQL + Drizzle ORM stack (no new databases)
259
+ - Must use existing auth middleware for WebSocket handshake validation
260
+ - Message ordering must be guaranteed via server-side timestamps
261
+
262
+ ## Testing
263
+ - QA: required
264
+ - UI Testing: required
265
+ - UI Testing Mode: manual
266
+ ```
267
+
268
+ **Why constraints are valuable:**
269
+ - Prevents agents from choosing a different WebSocket library
270
+ - Ensures new code integrates with existing database stack
271
+ - Manual UI testing because real-time interactions are hard to automate reliably
272
+
273
+ ---
274
+ *[Tons of Skills](https://tonsofskills.com) by [Intent Solutions](https://intentsolutions.io) | [jeremylongshore.com](https://jeremylongshore.com)*
@@ -0,0 +1,40 @@
1
+ # Testing Configuration
2
+
3
+ ## Testing Configuration
4
+
5
+ The Testing section controls which testing agents run.
6
+
7
+ ### Options
8
+
9
+ | Setting | Values | Meaning |
10
+ |---------|--------|---------|
11
+ | QA | required / optional / skip | API and unit tests |
12
+ | UI Testing | required / optional / skip | Browser-based E2E tests |
13
+ | UI Testing Mode | automated / manual | Auto-run or user-driven |
14
+
15
+ ### When to Use Each
16
+
17
+ **QA: required**
18
+ - New API endpoints
19
+ - Business logic changes
20
+ - Data validation rules
21
+
22
+ **QA: skip**
23
+ - Frontend-only changes
24
+ - Documentation updates
25
+ - Configuration changes
26
+
27
+ **UI Testing: required**
28
+ - User-facing features
29
+ - Form submissions
30
+ - Navigation flows
31
+
32
+ **UI Testing Mode: manual**
33
+ - Complex interactions
34
+ - Visual verification needed
35
+ - Exploratory testing
36
+
37
+ **UI Testing Mode: automated**
38
+ - Regression testing
39
+ - Standard CRUD flows
40
+ - Repeatable scenarios
@@ -0,0 +1,81 @@
1
+ ---
2
+ name: sprint-workflow
3
+ description: |
4
+ Execute this skill should be used when the user asks about "how sprints work", "sprint phases", "iteration workflow", "convergent development", "sprint lifecycle", "when to use sprints", or wants to understand the sprint execution model and its convergent diffusion approach. Use when appropriate context detected. Trigger with relevant phrases based on skill purpose.
5
+ allowed-tools: Read
6
+ version: 1.0.0
7
+ author: Damien Laine <damien.laine@gmail.com>
8
+ license: MIT
9
+ compatible-with: claude-code, codex, openclaw
10
+ tags: [community, workflow, sprint-workflow]
11
+ ---
12
+ # Sprint Workflow
13
+
14
+ ## Overview
15
+
16
+ Sprint Workflow describes the convergent diffusion execution model used by the Sprint plugin. A sprint progresses through six distinct phases -- from loading specifications through architectural planning, parallel implementation, testing, review, and finalization.
17
+
18
+ ## Prerequisites
19
+
20
+ - Sprint plugin installed (`/plugin install sprint`)
21
+ - Project onboarded via `/sprint:setup` (creates `.claude/project-goals.md` and `.claude/project-map.md`)
22
+ - Sprint created via `/sprint:new` with a completed `specs.md`
23
+ - Understanding of the agent system (see the `agent-patterns` skill)
24
+
25
+ ## Instructions
26
+
27
+ 1. **Phase 0 -- Load Specifications.** The orchestrator locates the sprint directory at `.claude/sprint/[N]/`, reads `specs.md` for requirements, reads `status.md` if resuming a prior iteration, and detects the project type for framework-specific agent selection. See `${CLAUDE_SKILL_DIR}/references/sprint-phases.md` for the full phase reference.
28
+ 2. **Phase 1 -- Architectural Planning.** The project-architect agent reads `project-map.md` for architecture context and `project-goals.md` for business objectives. It produces specification files (`api-contract.md`, `backend-specs.md`, `frontend-specs.md`) and returns SPAWN REQUEST blocks for implementation agents.
29
+ 3. **Phase 2 -- Implementation.** The orchestrator spawns implementation agents in parallel based on the architect's SPAWN REQUEST blocks. Agents include `python-dev`, `nextjs-dev`, `cicd-agent`, and `allpurpose-agent`. Each agent reads its assigned spec files and the shared `api-contract.md`, then returns a structured report.
30
+ 4. **Phase 3 -- Testing.** Testing agents execute sequentially: `qa-test-agent` runs first (API and unit tests), then `ui-test-agent` runs browser-based E2E tests. Framework-specific diagnostics agents (e.g., `nextjs-diagnostics-agent`) run in parallel with UI tests. All agents produce test reports.
31
+ 5. **Phase 4 -- Review and Iteration.** The architect reviews all agent reports, analyzes conformity against specifications, updates specs (removing completed items, adding fixes for failures), and updates `status.md`. The architect then decides: spawn more implementation agents, run more tests, or finalize.
32
+ 6. **Phase 5 -- Finalization.** The orchestrator writes the final `status.md` summary, ensures all spec files are in a consistent state, cleans up temporary files like `manual-test-report.md`, and signals FINALIZE to end the sprint.
33
+ 7. **Convergence model.** Each iteration reduces noise: completed work is removed from specs, working code is preserved, and only failures are re-addressed. Most sprints converge within 3-5 iterations. After 5 iterations without convergence, the orchestrator pauses and prompts for manual intervention.
34
+
35
+ ## Output
36
+
37
+ - Phase-by-phase execution log showing agent spawns, reports, and decisions
38
+ - Updated `status.md` after each iteration reflecting completed and remaining work
39
+ - Specification files that shrink with each iteration as requirements are satisfied
40
+ - Final `status.md` summary upon sprint completion
41
+ - FINALIZE signal to the orchestrator when all specs are satisfied
42
+
43
+ ## Error Handling
44
+
45
+ | Error | Cause | Solution |
46
+ |-------|-------|----------|
47
+ | Sprint stuck in iteration loop (hits 5 iterations) | Specs too broad or contain unresolvable conflicts | Review `status.md` for blocking issues; narrow scope or resolve conflicting requirements |
48
+ | Phase 2 agents not spawned | Architect SPAWN REQUEST missing or malformed | Verify architect agent produced valid SPAWN REQUEST blocks with correct agent names |
49
+ | Tests fail repeatedly on same issue | Implementation does not match contract | Compare agent output against `api-contract.md`; check for schema mismatches |
50
+ | Sprint cannot find specs | Wrong sprint directory number | Verify `.claude/sprint/[N]/specs.md` exists; run `/sprint:new` if needed |
51
+ | Architect skips testing phase | Testing section missing from `specs.md` | Add `QA: required` and `UI Testing: required` to the specs (see `spec-writing` skill) |
52
+
53
+ ## Examples
54
+
55
+ **Starting a new sprint:**
56
+ ```bash
57
+ /sprint:new # Creates .claude/sprint/1/specs.md
58
+ # Edit specs.md with requirements
59
+ /sprint # Executes the full phase lifecycle
60
+ ```
61
+
62
+ **Resuming after iteration pause:**
63
+ ```bash
64
+ # Review .claude/sprint/1/status.md for blockers
65
+ # Adjust specs.md to narrow scope or fix conflicts
66
+ /sprint # Resumes from Phase 0, reads updated specs and status
67
+ ```
68
+
69
+ **Typical convergence flow:**
70
+ ```
71
+ Iteration 1: Architect plans → 3 agents implement → tests find 2 failures
72
+ Iteration 2: Architect narrows specs to 2 fixes → agents patch → tests pass
73
+ Iteration 3: All specs satisfied → FINALIZE
74
+ ```
75
+
76
+ ## Resources
77
+
78
+ - `${CLAUDE_SKILL_DIR}/references/sprint-phases.md` -- Detailed reference for all six phases with agent assignments and handoff rules
79
+ - Agent patterns skill for SPAWN REQUEST format and report structure
80
+ - Spec writing skill for authoring effective `specs.md` files
81
+ - API contract skill for designing the shared interface between agents
@@ -0,0 +1,8 @@
1
+ # Error Handling Reference
2
+
3
+ - Invalid input: Prompts for correction
4
+ - Missing dependencies: Lists required components
5
+ - Permission errors: Suggests remediation steps
6
+
7
+ ---
8
+ *[Tons of Skills](https://tonsofskills.com) by [Intent Solutions](https://intentsolutions.io) | [jeremylongshore.com](https://jeremylongshore.com)*