@tgoodington/intuition 7.1.0 → 8.0.1
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/package.json +1 -1
- package/scripts/install-skills.js +11 -2
- package/scripts/uninstall-skills.js +4 -3
- package/skills/intuition-build/SKILL.md +308 -0
- package/skills/intuition-debugger/SKILL.md +22 -1
- package/skills/intuition-engineer/SKILL.md +302 -0
- package/skills/intuition-handoff/SKILL.md +123 -40
- package/skills/intuition-plan/SKILL.md +70 -23
- package/skills/intuition-start/SKILL.md +68 -21
- package/skills/intuition-execute/SKILL.md +0 -472
- package/skills/intuition-execute/references/faraday_core.md +0 -385
- package/skills/intuition-execute/references/sub_agents.md +0 -386
- package/skills/intuition-execute/references/templates/execution_report.md +0 -323
- package/skills/intuition-execute/references/templates/parallel_execution.md +0 -371
- package/skills/intuition-execute/references/templates/task_delegation.md +0 -327
|
@@ -1,386 +0,0 @@
|
|
|
1
|
-
# Architect Sub-Agents Reference
|
|
2
|
-
|
|
3
|
-
## Available Execution Sub-Agents
|
|
4
|
-
|
|
5
|
-
Delegate to these specialized agents (all run on Sonnet by default):
|
|
6
|
-
|
|
7
|
-
| Agent | Purpose | When to Use |
|
|
8
|
-
|-------|---------|-------------|
|
|
9
|
-
| **Code Writer** | Implements features, writes/edits code | New features, bug fixes, refactoring |
|
|
10
|
-
| **Test Runner** | Executes tests, reports results | After code changes, CI verification |
|
|
11
|
-
| **Documentation** | Updates docs, README, comments | After feature completion |
|
|
12
|
-
| **Research** | Explores codebase, investigates issues | Unknown territory, debugging |
|
|
13
|
-
| **Code Reviewer** | Reviews code quality | After Code Writer completes |
|
|
14
|
-
| **Security Expert** | Scans for secrets, vulnerabilities | Before any commit (MANDATORY) |
|
|
15
|
-
| **Technical Spec Writer** | Creates comprehensive technical specifications | After planning, before code implementation |
|
|
16
|
-
| **Communications Specialist** | Creates human-centric audience-specific documents | When new human-facing docs are needed |
|
|
17
|
-
|
|
18
|
-
## Task Delegation Patterns
|
|
19
|
-
|
|
20
|
-
### Code Writer Delegation
|
|
21
|
-
|
|
22
|
-
Use the Code Writer agent for implementing features and fixing bugs.
|
|
23
|
-
|
|
24
|
-
**When to use:**
|
|
25
|
-
- New feature implementation
|
|
26
|
-
- Bug fixes
|
|
27
|
-
- Code refactoring
|
|
28
|
-
- Adding new modules or components
|
|
29
|
-
|
|
30
|
-
**Example delegation:**
|
|
31
|
-
```
|
|
32
|
-
Code Writer Task: Implement user authentication module
|
|
33
|
-
|
|
34
|
-
Objective: Create a secure authentication system with login and registration
|
|
35
|
-
|
|
36
|
-
Files to create/modify:
|
|
37
|
-
- src/auth/auth.service.ts (new)
|
|
38
|
-
- src/auth/auth.controller.ts (new)
|
|
39
|
-
- src/auth/jwt.strategy.ts (new)
|
|
40
|
-
|
|
41
|
-
Acceptance Criteria:
|
|
42
|
-
- [ ] Login endpoint accepts email/password and returns JWT
|
|
43
|
-
- [ ] Registration creates new user with hashed password
|
|
44
|
-
- [ ] JWT validation works for protected routes
|
|
45
|
-
- [ ] Password reset functionality implemented
|
|
46
|
-
|
|
47
|
-
Constraints:
|
|
48
|
-
- Use bcrypt for password hashing
|
|
49
|
-
- Follow existing project code style
|
|
50
|
-
- Include proper error handling
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
### Test Runner Delegation
|
|
54
|
-
|
|
55
|
-
Use the Test Runner agent to execute tests and verify code quality.
|
|
56
|
-
|
|
57
|
-
**When to use:**
|
|
58
|
-
- After code changes to verify tests pass
|
|
59
|
-
- Running full test suite
|
|
60
|
-
- CI/CD integration verification
|
|
61
|
-
- Regression testing
|
|
62
|
-
|
|
63
|
-
**Example delegation:**
|
|
64
|
-
```
|
|
65
|
-
Test Runner Task: Execute test suite for authentication module
|
|
66
|
-
|
|
67
|
-
Objective: Verify all tests pass and no regressions introduced
|
|
68
|
-
|
|
69
|
-
Acceptance Criteria:
|
|
70
|
-
- [ ] All unit tests pass
|
|
71
|
-
- [ ] All integration tests pass
|
|
72
|
-
- [ ] Test coverage reported
|
|
73
|
-
- [ ] No failing tests in full suite
|
|
74
|
-
|
|
75
|
-
Files to test:
|
|
76
|
-
- src/auth/* (authentication module)
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
### Documentation Delegation
|
|
80
|
-
|
|
81
|
-
Use the Documentation agent to update docs and create reference materials.
|
|
82
|
-
|
|
83
|
-
**When to use:**
|
|
84
|
-
- After feature completion
|
|
85
|
-
- Updating README with new capabilities
|
|
86
|
-
- Adding API documentation
|
|
87
|
-
- Creating usage examples
|
|
88
|
-
|
|
89
|
-
**Example delegation:**
|
|
90
|
-
```
|
|
91
|
-
Documentation Task: Update API documentation for authentication endpoints
|
|
92
|
-
|
|
93
|
-
Objective: Document new authentication endpoints in API docs
|
|
94
|
-
|
|
95
|
-
Acceptance Criteria:
|
|
96
|
-
- [ ] Login endpoint documented with examples
|
|
97
|
-
- [ ] Registration endpoint documented
|
|
98
|
-
- [ ] Error responses documented
|
|
99
|
-
- [ ] Authentication flow explained
|
|
100
|
-
- [ ] Links are valid
|
|
101
|
-
|
|
102
|
-
Files to update:
|
|
103
|
-
- docs/api.md
|
|
104
|
-
- docs/authentication.md (create if needed)
|
|
105
|
-
- README.md (usage section)
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
### Research Delegation
|
|
109
|
-
|
|
110
|
-
Use the Research agent to explore and understand the codebase.
|
|
111
|
-
|
|
112
|
-
**When to use:**
|
|
113
|
-
- Investigating unknown parts of codebase
|
|
114
|
-
- Finding where to make changes
|
|
115
|
-
- Understanding existing patterns
|
|
116
|
-
- Debugging unknown issues
|
|
117
|
-
|
|
118
|
-
**Example delegation:**
|
|
119
|
-
```
|
|
120
|
-
Research Task: Investigate database connection handling
|
|
121
|
-
|
|
122
|
-
Objective: Understand how database connections are currently managed
|
|
123
|
-
|
|
124
|
-
Explore:
|
|
125
|
-
- Where database initialization happens
|
|
126
|
-
- How connection pooling is configured
|
|
127
|
-
- What patterns are used for database queries
|
|
128
|
-
- Error handling for connection failures
|
|
129
|
-
|
|
130
|
-
Report findings and recommendations.
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
### Code Reviewer Delegation
|
|
134
|
-
|
|
135
|
-
Use the Code Reviewer agent to review code quality and standards compliance.
|
|
136
|
-
|
|
137
|
-
**When to use:**
|
|
138
|
-
- After Code Writer completes implementation
|
|
139
|
-
- Before merging to main branch
|
|
140
|
-
- Ensuring code quality standards
|
|
141
|
-
- Catching potential issues
|
|
142
|
-
|
|
143
|
-
**Example delegation:**
|
|
144
|
-
```
|
|
145
|
-
Code Reviewer Task: Review authentication module implementation
|
|
146
|
-
|
|
147
|
-
Objective: Verify code quality and best practices
|
|
148
|
-
|
|
149
|
-
Review criteria:
|
|
150
|
-
- [ ] Code follows project style guide
|
|
151
|
-
- [ ] Error handling is comprehensive
|
|
152
|
-
- [ ] No code smells or anti-patterns
|
|
153
|
-
- [ ] Documentation is complete
|
|
154
|
-
- [ ] Tests are adequate
|
|
155
|
-
|
|
156
|
-
Files to review:
|
|
157
|
-
- src/auth/auth.service.ts
|
|
158
|
-
- src/auth/auth.controller.ts
|
|
159
|
-
- src/auth/jwt.strategy.ts
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
### Security Expert Delegation
|
|
163
|
-
|
|
164
|
-
Use the Security Expert agent to scan for vulnerabilities and security issues. **This is MANDATORY before any code is committed.**
|
|
165
|
-
|
|
166
|
-
**When to use:**
|
|
167
|
-
- Before merging any code (MANDATORY)
|
|
168
|
-
- Scanning for secrets in code
|
|
169
|
-
- Verifying no hardcoded credentials
|
|
170
|
-
- Checking for common vulnerabilities
|
|
171
|
-
- Reviewing security-sensitive changes
|
|
172
|
-
|
|
173
|
-
**Example delegation:**
|
|
174
|
-
```
|
|
175
|
-
Security Expert Task: Security scan for authentication module
|
|
176
|
-
|
|
177
|
-
Objective: Verify no security vulnerabilities or secrets in code
|
|
178
|
-
|
|
179
|
-
Check for:
|
|
180
|
-
- [ ] No hardcoded secrets or credentials
|
|
181
|
-
- [ ] No sensitive data in logs
|
|
182
|
-
- [ ] No common authentication vulnerabilities
|
|
183
|
-
- [ ] Proper input validation
|
|
184
|
-
- [ ] Secure password handling
|
|
185
|
-
- [ ] JWT security best practices
|
|
186
|
-
|
|
187
|
-
Files to scan:
|
|
188
|
-
- src/auth/* (entire authentication module)
|
|
189
|
-
- src/config/* (configuration files)
|
|
190
|
-
```
|
|
191
|
-
|
|
192
|
-
## Technical Spec Writer Delegation
|
|
193
|
-
|
|
194
|
-
Use the Technical Spec Writer agent to create detailed technical specifications before implementation begins.
|
|
195
|
-
|
|
196
|
-
**When to use:**
|
|
197
|
-
- After planning phase, before code implementation
|
|
198
|
-
- When feature complexity requires clear specification
|
|
199
|
-
- To prevent implementation rework from unclear requirements
|
|
200
|
-
- When multiple developers/teams need shared understanding
|
|
201
|
-
- To document architectural decisions and trade-offs
|
|
202
|
-
|
|
203
|
-
**Example delegation:**
|
|
204
|
-
```
|
|
205
|
-
Technical Spec Writer Task: Create specification for user authentication feature
|
|
206
|
-
|
|
207
|
-
Objective: Create comprehensive technical specification for authentication implementation
|
|
208
|
-
|
|
209
|
-
Source Materials:
|
|
210
|
-
- Plan from Waldo planning phase
|
|
211
|
-
- Existing authentication patterns in codebase
|
|
212
|
-
- Security requirements and compliance needs
|
|
213
|
-
|
|
214
|
-
Specification should include:
|
|
215
|
-
- [ ] API endpoint specifications (methods, paths, request/response formats)
|
|
216
|
-
- [ ] Data model and schema design
|
|
217
|
-
- [ ] Authentication flow diagram
|
|
218
|
-
- [ ] Error handling and edge cases
|
|
219
|
-
- [ ] Performance requirements
|
|
220
|
-
- [ ] Security considerations
|
|
221
|
-
- [ ] Integration points with existing systems
|
|
222
|
-
- [ ] Acceptance criteria for implementation
|
|
223
|
-
|
|
224
|
-
Output Location: docs/specs/authentication-spec.md
|
|
225
|
-
```
|
|
226
|
-
|
|
227
|
-
**Output:**
|
|
228
|
-
- Detailed technical specification in `docs/specs/` directory
|
|
229
|
-
- Human-facing documentation for developer reference
|
|
230
|
-
- NOT part of project memory system
|
|
231
|
-
- Ready for Code Writer to implement with clarity
|
|
232
|
-
|
|
233
|
-
## Communications Specialist Delegation
|
|
234
|
-
|
|
235
|
-
Use the Communications Specialist agent to create human-centric documents from technical specifications when different audiences need tailored information.
|
|
236
|
-
|
|
237
|
-
**When to use:**
|
|
238
|
-
- When creating getting-started guides from technical specs
|
|
239
|
-
- When translating technical features into user-facing documentation
|
|
240
|
-
- When creating executive summaries or business value docs
|
|
241
|
-
- When different audiences (users, developers, stakeholders) need different versions
|
|
242
|
-
- When existing technical docs need an accessible companion guide
|
|
243
|
-
|
|
244
|
-
**NOT when to use:**
|
|
245
|
-
- Modifying existing technical specifications
|
|
246
|
-
- Creating marketing materials
|
|
247
|
-
- Post-processing existing documentation
|
|
248
|
-
- Single-audience technical documents (use Documentation agent instead)
|
|
249
|
-
|
|
250
|
-
**Example delegation:**
|
|
251
|
-
```
|
|
252
|
-
Communications Specialist Task: Create user-facing guide from technical authentication spec
|
|
253
|
-
|
|
254
|
-
Objective: Create getting-started guide for end-users based on technical spec
|
|
255
|
-
|
|
256
|
-
Source Material:
|
|
257
|
-
- docs/specs/authentication-spec.md (technical specification)
|
|
258
|
-
- Existing user guides for reference on tone/style
|
|
259
|
-
|
|
260
|
-
Audience: End users (non-technical)
|
|
261
|
-
|
|
262
|
-
Create NEW document including:
|
|
263
|
-
- [ ] Overview of what authentication does (for users)
|
|
264
|
-
- [ ] Step-by-step guide for users to authenticate
|
|
265
|
-
- [ ] Common tasks and how to do them
|
|
266
|
-
- [ ] Troubleshooting common issues
|
|
267
|
-
- [ ] When to contact support
|
|
268
|
-
- [ ] Link to advanced/developer documentation
|
|
269
|
-
|
|
270
|
-
Output Location: docs/guides/authentication-user-guide.md
|
|
271
|
-
```
|
|
272
|
-
|
|
273
|
-
**Output:**
|
|
274
|
-
- NEW human-facing document in appropriate location
|
|
275
|
-
- Emits `[DOCUMENT: communication]` flag
|
|
276
|
-
- NOT a modification of technical spec
|
|
277
|
-
- Accessible language, audience-appropriate tone
|
|
278
|
-
|
|
279
|
-
## Dynamic Sub-Agent Discovery
|
|
280
|
-
|
|
281
|
-
When executing a plan that requires a specialized agent type not in the above list, you can discover and employ new agent archetypes:
|
|
282
|
-
|
|
283
|
-
**Process:**
|
|
284
|
-
1. Identify the need: "I need [deployment/monitoring/performance/etc] expertise"
|
|
285
|
-
2. Request Research agent to find best practices for that agent type
|
|
286
|
-
3. Document findings in `docs/intuition-framework-improvements.md` with date, archetype needed, and best practices found
|
|
287
|
-
4. Use findings to adapt task for existing agent OR clearly describe need for base Claude to implement framework-wide
|
|
288
|
-
|
|
289
|
-
**Example:** If executing a plan involving infrastructure deployment, delegate to Research to investigate deployment agent patterns. Research finds CI/CD and infrastructure-as-code best practices. Document in framework-improvements.md. Use findings to adapt Code Writer instructions OR describe deployment need for future framework adoption.
|
|
290
|
-
|
|
291
|
-
## Parallel Task Delegation Patterns
|
|
292
|
-
|
|
293
|
-
### Pattern 1: Multiple Code Writers (Different Files)
|
|
294
|
-
|
|
295
|
-
When implementing features across different files with no dependencies:
|
|
296
|
-
|
|
297
|
-
```
|
|
298
|
-
Task 1: Code Writer - Implement User model (models/user.ts)
|
|
299
|
-
Task 2: Code Writer - Implement Order model (models/order.ts)
|
|
300
|
-
Task 3: Code Writer - Implement Product model (models/product.ts)
|
|
301
|
-
```
|
|
302
|
-
|
|
303
|
-
**Why parallel?** Different files, no dependencies, all create similar models.
|
|
304
|
-
|
|
305
|
-
### Pattern 2: Code + Documentation
|
|
306
|
-
|
|
307
|
-
After a code change is complete, run testing and documentation in parallel:
|
|
308
|
-
|
|
309
|
-
```
|
|
310
|
-
Task 1: Test Runner - Run test suite
|
|
311
|
-
Task 2: Documentation - Update API documentation
|
|
312
|
-
```
|
|
313
|
-
|
|
314
|
-
**Why parallel?** Documentation doesn't need test results; both reference the completed code.
|
|
315
|
-
|
|
316
|
-
### Pattern 3: Multiple Research Tasks
|
|
317
|
-
|
|
318
|
-
Exploring different areas of unknown codebase:
|
|
319
|
-
|
|
320
|
-
```
|
|
321
|
-
Task 1: Research - Investigate authentication implementation
|
|
322
|
-
Task 2: Research - Investigate database schema design
|
|
323
|
-
Task 3: Research - Investigate API routing structure
|
|
324
|
-
```
|
|
325
|
-
|
|
326
|
-
**Why parallel?** Each explores independent area; results combine for full picture.
|
|
327
|
-
|
|
328
|
-
### Pattern 4: Multi-Component Feature
|
|
329
|
-
|
|
330
|
-
Implementing a feature with clear component boundaries:
|
|
331
|
-
|
|
332
|
-
```
|
|
333
|
-
Task 1: Code Writer - Add frontend form component (components/UserForm.tsx)
|
|
334
|
-
Task 2: Code Writer - Add backend API endpoint (routes/users.ts)
|
|
335
|
-
Task 3: Code Writer - Add database migration (migrations/001_add_users.sql)
|
|
336
|
-
```
|
|
337
|
-
|
|
338
|
-
**Why parallel?** If the interface is pre-defined, each can be implemented independently.
|
|
339
|
-
|
|
340
|
-
## Sequential Task Patterns
|
|
341
|
-
|
|
342
|
-
### Pattern 1: Code Then Verify
|
|
343
|
-
|
|
344
|
-
Code must be written before it can be tested:
|
|
345
|
-
|
|
346
|
-
```
|
|
347
|
-
Task 1: Code Writer - Implement feature
|
|
348
|
-
[Wait for completion]
|
|
349
|
-
Task 2: Test Runner - Run tests
|
|
350
|
-
[Wait for completion]
|
|
351
|
-
Task 3: Code Reviewer - Review code
|
|
352
|
-
[Wait for completion]
|
|
353
|
-
Task 4: Security Expert - Security scan
|
|
354
|
-
```
|
|
355
|
-
|
|
356
|
-
### Pattern 2: Exploration Then Implementation
|
|
357
|
-
|
|
358
|
-
Must understand codebase before implementing changes:
|
|
359
|
-
|
|
360
|
-
```
|
|
361
|
-
Task 1: Research - Investigate authentication patterns
|
|
362
|
-
[Wait for findings]
|
|
363
|
-
Task 2: Code Writer - Implement new authentication method (informed by research)
|
|
364
|
-
```
|
|
365
|
-
|
|
366
|
-
### Pattern 3: Verification Before Security Scan
|
|
367
|
-
|
|
368
|
-
Security Expert reviews code that exists:
|
|
369
|
-
|
|
370
|
-
```
|
|
371
|
-
Task 1: Code Writer - Implement changes
|
|
372
|
-
[Wait for completion]
|
|
373
|
-
Task 2: Security Expert - Scan for vulnerabilities (MANDATORY)
|
|
374
|
-
```
|
|
375
|
-
|
|
376
|
-
## Delegation Checklist
|
|
377
|
-
|
|
378
|
-
Before delegating a task, ensure:
|
|
379
|
-
|
|
380
|
-
- [ ] **Clear objective** - What should the agent accomplish?
|
|
381
|
-
- [ ] **Context provided** - What information does the agent need?
|
|
382
|
-
- [ ] **Acceptance criteria** - How will I know it's complete?
|
|
383
|
-
- [ ] **Files specified** - What files should be modified?
|
|
384
|
-
- [ ] **Constraints listed** - What limitations apply?
|
|
385
|
-
- [ ] **Failure strategy** - What if something goes wrong?
|
|
386
|
-
- [ ] **Dependencies resolved** - Does the agent have what it needs?
|
|
@@ -1,323 +0,0 @@
|
|
|
1
|
-
# Execution Report Format
|
|
2
|
-
|
|
3
|
-
## Overview
|
|
4
|
-
|
|
5
|
-
When execution is complete, provide a comprehensive report demonstrating what was accomplished and verifying all quality gates have been met.
|
|
6
|
-
|
|
7
|
-
## Complete Execution Report Format
|
|
8
|
-
|
|
9
|
-
```markdown
|
|
10
|
-
## Execution Complete
|
|
11
|
-
|
|
12
|
-
**Plan:** [Plan title]
|
|
13
|
-
**Status:** Success / Partial / Failed
|
|
14
|
-
|
|
15
|
-
**Tasks Completed:**
|
|
16
|
-
- [x] Task 1 - [Brief outcome]
|
|
17
|
-
- [x] Task 2 - [Brief outcome]
|
|
18
|
-
|
|
19
|
-
**Verification Results:**
|
|
20
|
-
- Security Review: PASS
|
|
21
|
-
- Code Review: PASS (if applicable)
|
|
22
|
-
- Tests: X passed, Y failed (if applicable)
|
|
23
|
-
|
|
24
|
-
**Files Modified:**
|
|
25
|
-
- path/to/file.ts - [what changed]
|
|
26
|
-
|
|
27
|
-
**Issues Encountered:**
|
|
28
|
-
- [Any problems and how they were resolved]
|
|
29
|
-
|
|
30
|
-
**Recommendations:**
|
|
31
|
-
- [Follow-up items or suggestions]
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
## Section Details
|
|
35
|
-
|
|
36
|
-
### Plan Header
|
|
37
|
-
|
|
38
|
-
**Plan Title:** Exactly as presented to user
|
|
39
|
-
**Status:** One of:
|
|
40
|
-
- **Success**: All tasks completed successfully, all quality gates passed
|
|
41
|
-
- **Partial**: Some tasks completed, some failed but escalated/handled appropriately
|
|
42
|
-
- **Failed**: Plan could not be executed, escalated to user
|
|
43
|
-
|
|
44
|
-
**Example:**
|
|
45
|
-
```markdown
|
|
46
|
-
## Execution Complete
|
|
47
|
-
|
|
48
|
-
**Plan:** Add Real-Time Notifications Feature
|
|
49
|
-
**Status:** Success
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
### Tasks Completed
|
|
53
|
-
|
|
54
|
-
List all tasks with outcomes. Use checkbox format to show completion status.
|
|
55
|
-
|
|
56
|
-
**Format:**
|
|
57
|
-
```markdown
|
|
58
|
-
**Tasks Completed:**
|
|
59
|
-
- [x] Task 1 - Brief description of what was accomplished
|
|
60
|
-
- [x] Task 2 - Brief description of what was accomplished
|
|
61
|
-
- [ ] Task 3 - Was not completed (explain why)
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
**Example:**
|
|
65
|
-
```markdown
|
|
66
|
-
**Tasks Completed:**
|
|
67
|
-
- [x] Task 1 - Create Notification model and database schema
|
|
68
|
-
- [x] Task 2 - Implement WebSocket server for real-time updates
|
|
69
|
-
- [x] Task 3 - Add notification API endpoints (create, list, mark as read)
|
|
70
|
-
- [x] Task 4 - Implement frontend notification components
|
|
71
|
-
- [x] Task 5 - Add unit tests for notification service
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
### Verification Results
|
|
75
|
-
|
|
76
|
-
Report results of all verification activities. Include results of:
|
|
77
|
-
- **Security Review**: Mandatory - PASS or FAIL
|
|
78
|
-
- **Code Review**: If code was written
|
|
79
|
-
- **Tests**: If tests were run
|
|
80
|
-
|
|
81
|
-
**Format:**
|
|
82
|
-
```markdown
|
|
83
|
-
**Verification Results:**
|
|
84
|
-
- Security Review: PASS
|
|
85
|
-
- Code Review: PASS (no issues found, follows project conventions)
|
|
86
|
-
- Tests: 45 passed, 0 failed, 2 skipped
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
**Details to include:**
|
|
90
|
-
- Security Review: Any issues found? Remediated?
|
|
91
|
-
- Code Review: Code quality assessment, any improvements suggested?
|
|
92
|
-
- Tests: Coverage percentage, any failing tests, regressions?
|
|
93
|
-
|
|
94
|
-
**Example:**
|
|
95
|
-
```markdown
|
|
96
|
-
**Verification Results:**
|
|
97
|
-
- Security Review: PASS - No hardcoded secrets, input validation verified, password hashing secure
|
|
98
|
-
- Code Review: PASS - Code follows TypeScript conventions, error handling comprehensive, documentation complete
|
|
99
|
-
- Tests: 52 passed, 0 failed, 1 skipped - Coverage: 89% for auth module
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
### Files Modified
|
|
103
|
-
|
|
104
|
-
List all files that were created or modified. Include brief description of changes.
|
|
105
|
-
|
|
106
|
-
**Format:**
|
|
107
|
-
```markdown
|
|
108
|
-
**Files Modified:**
|
|
109
|
-
- src/auth/auth.service.ts - Created new service with login/register functions
|
|
110
|
-
- src/auth/auth.controller.ts - Created new controller with POST endpoints
|
|
111
|
-
- src/app.module.ts - Added AuthModule import and JWT configuration
|
|
112
|
-
- src/__tests__/auth.spec.ts - Created test suite with 15 test cases
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
**Best Practices:**
|
|
116
|
-
- Include created files (mark as "Created:" or "New:")
|
|
117
|
-
- Include modified files with brief change description
|
|
118
|
-
- Include deleted files if any (mark as "Deleted:")
|
|
119
|
-
- Use relative paths from project root
|
|
120
|
-
|
|
121
|
-
**Example:**
|
|
122
|
-
```markdown
|
|
123
|
-
**Files Modified:**
|
|
124
|
-
- src/notifications/notifications.model.ts (Created) - Notification entity with user and timestamp fields
|
|
125
|
-
- src/notifications/notifications.service.ts (Created) - Service with CRUD operations
|
|
126
|
-
- src/notifications/notifications.controller.ts (Created) - REST API endpoints
|
|
127
|
-
- src/notifications/notifications.gateway.ts (Created) - WebSocket gateway for real-time updates
|
|
128
|
-
- src/notifications/__tests__/notifications.service.spec.ts (Created) - 15 unit tests
|
|
129
|
-
- src/app.module.ts (Modified) - Added NotificationsModule and WebSocketGateway configuration
|
|
130
|
-
- docs/api.md (Modified) - Added notification endpoints documentation
|
|
131
|
-
- package.json (Modified) - Added @nestjs/websockets dependency
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
### Issues Encountered
|
|
135
|
-
|
|
136
|
-
Document any problems that occurred and how they were resolved.
|
|
137
|
-
|
|
138
|
-
**Format:**
|
|
139
|
-
```markdown
|
|
140
|
-
**Issues Encountered:**
|
|
141
|
-
- Issue 1: [Description] - Resolution: [How it was fixed]
|
|
142
|
-
- Issue 2: [Description] - Resolution: [How it was fixed]
|
|
143
|
-
```
|
|
144
|
-
|
|
145
|
-
**When to include:**
|
|
146
|
-
- Any task failures that were retried
|
|
147
|
-
- Fallbacks that were used
|
|
148
|
-
- Unexpected complications
|
|
149
|
-
- Workarounds implemented
|
|
150
|
-
- Assumptions that proved incorrect
|
|
151
|
-
|
|
152
|
-
**When NOT to include:**
|
|
153
|
-
- Minor warnings or notices
|
|
154
|
-
- Expected temporary debug output
|
|
155
|
-
- Normal task execution messages
|
|
156
|
-
|
|
157
|
-
**Example:**
|
|
158
|
-
```markdown
|
|
159
|
-
**Issues Encountered:**
|
|
160
|
-
- WebSocket test failures due to timing issues - Resolution: Added proper async/await and increased timeout delays
|
|
161
|
-
- Database migration failed first attempt - Resolution: Checked existing tables, updated migration script, re-ran successfully
|
|
162
|
-
- Initial code review requested refactoring - Resolution: Code Writer updated to follow patterns, re-reviewed and approved
|
|
163
|
-
```
|
|
164
|
-
|
|
165
|
-
### Recommendations
|
|
166
|
-
|
|
167
|
-
Suggest follow-up items, improvements, or next steps.
|
|
168
|
-
|
|
169
|
-
**Categories:**
|
|
170
|
-
- **Follow-up tasks**: Work that should happen next
|
|
171
|
-
- **Improvements**: Enhancements for existing code
|
|
172
|
-
- **Testing**: Additional testing needed
|
|
173
|
-
- **Documentation**: Further documentation needed
|
|
174
|
-
- **Optimization**: Performance or maintainability improvements
|
|
175
|
-
- **Future phases**: What should be done next
|
|
176
|
-
|
|
177
|
-
**Example:**
|
|
178
|
-
```markdown
|
|
179
|
-
**Recommendations:**
|
|
180
|
-
- Next: Implement push notifications to mobile app
|
|
181
|
-
- Next: Add notification preferences/settings UI
|
|
182
|
-
- Improvement: Add caching for notification queries (performance optimization)
|
|
183
|
-
- Testing: Add end-to-end tests for notification flow
|
|
184
|
-
- Documentation: Create user guide for notification preferences feature
|
|
185
|
-
- Follow-up: Monitor WebSocket connection stability in production
|
|
186
|
-
```
|
|
187
|
-
|
|
188
|
-
## Report Sections for Different Scenarios
|
|
189
|
-
|
|
190
|
-
### Successful Execution (All Tasks Passed)
|
|
191
|
-
|
|
192
|
-
```markdown
|
|
193
|
-
## Execution Complete
|
|
194
|
-
|
|
195
|
-
**Plan:** Add Real-Time Notifications
|
|
196
|
-
**Status:** Success
|
|
197
|
-
|
|
198
|
-
All 5 tasks completed successfully. All quality gates passed.
|
|
199
|
-
|
|
200
|
-
**Tasks Completed:**
|
|
201
|
-
- [x] Task 1 - Create notification models and schema
|
|
202
|
-
- [x] Task 2 - Implement WebSocket server
|
|
203
|
-
- [x] Task 3 - Build notification API endpoints
|
|
204
|
-
- [x] Task 4 - Create frontend components
|
|
205
|
-
- [x] Task 5 - Add comprehensive tests
|
|
206
|
-
|
|
207
|
-
**Verification Results:**
|
|
208
|
-
- Security Review: PASS - No vulnerabilities found
|
|
209
|
-
- Code Review: PASS - High quality, well-documented
|
|
210
|
-
- Tests: 48 passed, 0 failed - 91% coverage
|
|
211
|
-
|
|
212
|
-
**Files Modified:**
|
|
213
|
-
- src/notifications/ (Created) - Full notification module
|
|
214
|
-
- src/app.module.ts (Modified) - Added NotificationsModule
|
|
215
|
-
- docs/api.md (Modified) - Added API documentation
|
|
216
|
-
|
|
217
|
-
**Issues Encountered:**
|
|
218
|
-
None - smooth execution throughout.
|
|
219
|
-
|
|
220
|
-
**Recommendations:**
|
|
221
|
-
- Monitor WebSocket connection performance in production
|
|
222
|
-
- Plan for notification preferences feature in next phase
|
|
223
|
-
- Consider adding read receipts for notifications
|
|
224
|
-
```
|
|
225
|
-
|
|
226
|
-
### Partial Execution (Some Issues Resolved)
|
|
227
|
-
|
|
228
|
-
```markdown
|
|
229
|
-
## Execution Complete
|
|
230
|
-
|
|
231
|
-
**Plan:** Add Real-Time Notifications
|
|
232
|
-
**Status:** Partial
|
|
233
|
-
|
|
234
|
-
4 of 5 tasks completed. 1 task required escalation.
|
|
235
|
-
|
|
236
|
-
**Tasks Completed:**
|
|
237
|
-
- [x] Task 1 - Create notification models and schema
|
|
238
|
-
- [x] Task 2 - Implement WebSocket server
|
|
239
|
-
- [x] Task 3 - Build notification API endpoints
|
|
240
|
-
- [x] Task 4 - Create frontend components
|
|
241
|
-
- [ ] Task 5 - Add comprehensive tests (Escalated)
|
|
242
|
-
|
|
243
|
-
**Verification Results:**
|
|
244
|
-
- Security Review: PASS - No vulnerabilities found
|
|
245
|
-
- Code Review: PASS - Minor improvements suggested, implemented
|
|
246
|
-
- Tests: 32 passed, 0 failed - 76% coverage (incomplete)
|
|
247
|
-
|
|
248
|
-
**Files Modified:**
|
|
249
|
-
- src/notifications/ (Created) - Core notification module
|
|
250
|
-
- src/app.module.ts (Modified) - Added NotificationsModule
|
|
251
|
-
- docs/api.md (Modified) - Added API documentation
|
|
252
|
-
|
|
253
|
-
**Issues Encountered:**
|
|
254
|
-
- Test environment setup required additional configuration - Resolved by researching and configuring WebSocket test utilities
|
|
255
|
-
- Code review requested refactoring of error handling - Resolved in second iteration
|
|
256
|
-
- Task 5 requires integration testing setup beyond scope - Escalated to user for prioritization
|
|
257
|
-
|
|
258
|
-
**Recommendations:**
|
|
259
|
-
- Task 5 (integration tests) should be scheduled separately as dedicated task
|
|
260
|
-
- Production monitoring setup should be planned before deployment
|
|
261
|
-
- Plan for notification preferences as follow-up feature
|
|
262
|
-
```
|
|
263
|
-
|
|
264
|
-
### Failed Execution (Major Issues)
|
|
265
|
-
|
|
266
|
-
```markdown
|
|
267
|
-
## Execution Complete
|
|
268
|
-
|
|
269
|
-
**Plan:** Add Real-Time Notifications
|
|
270
|
-
**Status:** Failed
|
|
271
|
-
|
|
272
|
-
Plan execution halted due to architectural concerns. Escalated to user.
|
|
273
|
-
|
|
274
|
-
**Tasks Completed:**
|
|
275
|
-
- [x] Task 1 - Create notification models and schema
|
|
276
|
-
- [ ] Task 2 - Implement WebSocket server (Not Started)
|
|
277
|
-
- [ ] Task 3 - Build notification API endpoints (Not Started)
|
|
278
|
-
- [ ] Task 4 - Create frontend components (Not Started)
|
|
279
|
-
- [ ] Task 5 - Add comprehensive tests (Not Started)
|
|
280
|
-
|
|
281
|
-
**Verification Results:**
|
|
282
|
-
- Task 1 schema review passed
|
|
283
|
-
- Architecture review for WebSocket revealed compatibility issues
|
|
284
|
-
|
|
285
|
-
**Files Modified:**
|
|
286
|
-
- src/notifications/notification.model.ts (Created)
|
|
287
|
-
|
|
288
|
-
**Issues Encountered:**
|
|
289
|
-
- Database schema implementation raised architectural questions about scalability
|
|
290
|
-
- WebSocket approach may conflict with current load balancing strategy
|
|
291
|
-
- Security Expert identified potential concerns with real-time message handling
|
|
292
|
-
- Plan assumptions about system load capacity need validation
|
|
293
|
-
|
|
294
|
-
**Recommendations:**
|
|
295
|
-
- Conduct architecture review with team before proceeding
|
|
296
|
-
- Verify WebSocket compatibility with current deployment infrastructure
|
|
297
|
-
- Revisit scalability assumptions in plan
|
|
298
|
-
- User input needed on approach before execution continues
|
|
299
|
-
```
|
|
300
|
-
|
|
301
|
-
## Quality Gate Verification Checklist
|
|
302
|
-
|
|
303
|
-
Before submitting execution report, verify:
|
|
304
|
-
|
|
305
|
-
### Mandatory Gates
|
|
306
|
-
- [ ] All tasks completed or properly escalated
|
|
307
|
-
- [ ] Security Expert has reviewed (NO EXCEPTIONS)
|
|
308
|
-
- [ ] All acceptance criteria verified or documented as incomplete
|
|
309
|
-
|
|
310
|
-
### If Code Was Written
|
|
311
|
-
- [ ] Code Reviewer has approved
|
|
312
|
-
- [ ] Tests pass (or documented why)
|
|
313
|
-
- [ ] No regressions introduced
|
|
314
|
-
|
|
315
|
-
### If Docs Were Updated
|
|
316
|
-
- [ ] Documentation is accurate
|
|
317
|
-
- [ ] Links are valid
|
|
318
|
-
|
|
319
|
-
### Report Quality
|
|
320
|
-
- [ ] Report is complete and accurate
|
|
321
|
-
- [ ] All files listed and described
|
|
322
|
-
- [ ] Issues and resolutions documented
|
|
323
|
-
- [ ] Recommendations are actionable
|