@codemcp/workflows-core 5.2.2 → 5.2.3

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.
@@ -27,25 +27,26 @@ states:
27
27
  analyze:
28
28
  description: 'Analyze current state and requirements (optional for new features)'
29
29
  default_instructions: |
30
- You are analyzing the current state to understand the context for this feature development.
30
+ Analyze the current state to understand the context for this feature development.
31
31
 
32
32
  **Analysis Tasks:**
33
- 1. **For New Features**: This phase can be brief - focus on understanding:
34
- - How this feature fits into the existing system
35
- - Integration points with current functionality
36
- - Existing patterns and conventions to follow
37
-
38
- 2. **For Enhancements**: Conduct thorough analysis:
39
- - Current implementation and its limitations
40
- - User pain points and feedback
41
- - Performance or usability issues
42
- - Technical debt that should be addressed
43
-
44
- 3. **Context Gathering**:
45
- - Review existing codebase and architecture
46
- - Understand current user workflows
47
- - Identify constraints and dependencies
48
- - Document assumptions about the current state
33
+
34
+ **For New Features**: This phase can be brief. Focus on understanding:
35
+ - How this feature fits into the existing system
36
+ - Integration points with current functionality
37
+ - Existing patterns and conventions to follow
38
+
39
+ **For Enhancements**: Conduct thorough analysis:
40
+ - Current implementation and its limitations
41
+ - User pain points and feedback
42
+ - Performance or usability issues
43
+ - Technical debt that should be addressed
44
+
45
+ **Context Gathering**:
46
+ - Review existing codebase and architecture
47
+ - Understand current user workflows
48
+ - Identify constraints and dependencies
49
+ - Document assumptions about the current state
49
50
 
50
51
  **Output**: Create `$VIBE_DIR/specs/$BRANCH_NAME/current-state-analysis.md` documenting your findings. For simple new features, this can be brief. For enhancements, be comprehensive.
51
52
 
@@ -66,37 +67,39 @@ states:
66
67
  specify:
67
68
  description: 'Create feature specification'
68
69
  default_instructions: |
69
- You are creating the feature specification that will guide all development decisions.
70
+ Create the feature specification that will guide all development decisions.
70
71
 
71
72
  **Specification Process:**
72
73
 
73
- 1. **Parse Requirements**: Extract key concepts from the user's description
74
- - Identify: actors, actions, data, constraints
75
- - Consider existing system context (from analysis if performed)
76
- - Focus on WHAT users need and WHY, not HOW to implement
77
-
78
- 2. **Interactive Requirements Gathering**: Ask clarifying questions about:
79
- - **Integration Points**: How should this integrate with existing features?
80
- - **User Impact**: Which existing users will be affected?
81
- - **Data Dependencies**: What existing data does this feature need?
82
- - **Performance**: Any specific performance requirements for this feature?
83
- - **Compatibility**: Any backward compatibility concerns?
84
-
85
- 3. **Handle Ambiguities Systematically**:
86
- - Make informed guesses based on context, existing patterns, and industry standards
87
- - Only use [NEEDS CLARIFICATION: specific question] for critical decisions that:
88
- - Significantly impact feature scope or user experience
89
- - Have multiple reasonable interpretations with different implications
90
- - Lack any reasonable default
91
- - **LIMIT: Maximum 3 [NEEDS CLARIFICATION] markers total**
92
- - Prioritize: scope > security/privacy > user experience > technical details
93
-
94
- 4. **Quality Validation**:
95
- - No implementation details (languages, frameworks, APIs)
96
- - Written for non-technical stakeholders
97
- - All requirements are testable
98
- - Success criteria are measurable and technology-agnostic
99
- - Considers existing system constraints
74
+ **STEP 1: Parse Requirements**
75
+ - Extract key concepts from the user's description
76
+ - Identify: actors, actions, data, constraints
77
+ - Consider existing system context (from analysis if performed)
78
+ - Focus on WHAT users need and WHY, not HOW to implement
79
+
80
+ **STEP 2: Interactive Requirements Gathering**
81
+ Ask clarifying questions about:
82
+ - **Integration Points**: How should this integrate with existing features?
83
+ - **User Impact**: Which existing users will be affected?
84
+ - **Data Dependencies**: What existing data does this feature need?
85
+ - **Performance**: Any specific performance requirements for this feature?
86
+ - **Compatibility**: Any backward compatibility concerns?
87
+
88
+ **STEP 3: Handle Ambiguities Systematically**
89
+ - Make informed guesses based on context, existing patterns, and industry standards
90
+ - Only use `[NEEDS CLARIFICATION: specific question]` for critical decisions that:
91
+ - Significantly impact feature scope or user experience
92
+ - Have multiple reasonable interpretations with different implications
93
+ - Lack any reasonable default
94
+ - **LIMIT: Maximum 3** `[NEEDS CLARIFICATION]` markers total
95
+ - Prioritize: scope > security/privacy > user experience > technical details
96
+
97
+ **STEP 4: Quality Validation**
98
+ - Ensure no implementation details (languages, frameworks, APIs)
99
+ - Ensure written for non-technical stakeholders
100
+ - Verify all requirements are testable
101
+ - Ensure success criteria are measurable and technology-agnostic
102
+ - Consider existing system constraints
100
103
 
101
104
  Create `$VIBE_DIR/specs/$BRANCH_NAME/spec.md` using the template provided below.
102
105
  additional_instructions: |
@@ -203,38 +206,38 @@ states:
203
206
  clarify:
204
207
  description: 'Review and clarify specification details'
205
208
  default_instructions: |
206
- You are reviewing the specification for completeness and clarity.
209
+ Review the specification for completeness and clarity.
207
210
 
208
211
  **Clarification Process:**
209
212
 
210
- 1. **Specification Review**:
211
- - Check for any remaining [NEEDS CLARIFICATION] markers
212
- - Verify all functional requirements are testable
213
- - Ensure success criteria are measurable
214
- - Validate user scenarios are complete
215
-
216
- 2. **Handle Remaining Clarifications**:
217
- If [NEEDS CLARIFICATION] markers exist:
218
- - Extract all markers from the spec
219
- - For each clarification (max 3), present options in structured format:
220
- ```
221
- ## Question [N]: [Topic]
222
- **Context**: [Quote relevant spec section]
223
- **What we need to know**: [Specific question]
224
- **Suggested Answers**:
225
- | Option | Answer | Implications |
226
- |--------|--------|--------------|
227
- | A | [First option] | [Impact on feature] |
228
- | B | [Second option] | [Impact on feature] |
229
- | C | [Third option] | [Impact on feature] |
230
- ```
231
- - Wait for user responses
232
- - Update specification with chosen answers
233
-
234
- 3. **Final Validation**:
235
- - Ensure no implementation details leaked in
236
- - Verify requirements align with existing system
237
- - Confirm specification is ready for planning
213
+ **STEP 1: Specification Review**
214
+ - Check for any remaining `[NEEDS CLARIFICATION]` markers
215
+ - Verify all functional requirements are testable
216
+ - Ensure success criteria are measurable
217
+ - Validate user scenarios are complete
218
+
219
+ **STEP 2: Handle Remaining Clarifications**
220
+ If `[NEEDS CLARIFICATION]` markers exist:
221
+ - Extract all markers from the spec
222
+ - For each clarification (max 3), present options in structured format:
223
+ ```
224
+ ## Question [N]: [Topic]
225
+ **Context**: [Quote relevant spec section]
226
+ **What we need to know**: [Specific question]
227
+ **Suggested Answers**:
228
+ | Option | Answer | Implications |
229
+ |--------|--------|--------------|
230
+ | A | [First option] | [Impact on feature] |
231
+ | B | [Second option] | [Impact on feature] |
232
+ | C | [Third option] | [Impact on feature] |
233
+ ```
234
+ - Wait for user responses
235
+ - Update specification with chosen answers
236
+
237
+ **STEP 3: Final Validation**
238
+ - Ensure no implementation details leaked in
239
+ - Verify requirements align with existing system
240
+ - Confirm specification is ready for planning
238
241
 
239
242
  **Output**: Updated `$VIBE_DIR/specs/$BRANCH_NAME/spec.md` with all clarifications resolved and ready for implementation planning.
240
243
 
@@ -253,46 +256,47 @@ states:
253
256
  plan:
254
257
  description: 'Generate implementation plan with constitutional compliance'
255
258
  default_instructions: |
256
- You are creating the implementation plan, considering existing system architecture.
259
+ Create the implementation plan, considering existing system architecture.
257
260
 
258
261
  **Planning Process:**
259
262
 
260
- 1. **Load Context**:
261
- - Read the feature specification (`$VIBE_DIR/specs/$BRANCH_NAME/spec.md`)
262
- - Read analysis findings (`$VIBE_DIR/specs/$BRANCH_NAME/current-state-analysis.md` if exists)
263
- - Review existing project constitution or architectural principles
264
- - Understand current system architecture and patterns
265
-
266
- 2. **Interactive Integration Planning**: Ask the user about:
267
- - **Technology Consistency**: Should this use the same tech stack as existing features?
268
- - **Architecture Alignment**: How should this fit into the current architecture?
269
- - **Database Changes**: Any new data models or schema changes needed?
270
-
271
- 3. **Technical Context Analysis**:
272
- - Identify how this feature integrates with existing system
273
- - Map dependencies and integration points
274
- - Choose appropriate technology stack (consistent with existing)
275
- - Mark unknowns as "NEEDS CLARIFICATION" for research
276
-
277
- 4. **Constitutional/Architectural Compliance**:
278
- - Evaluate approach against existing architectural principles
279
- - Ensure consistency with current patterns and conventions
280
- - Identify any violations and justify or resolve them
281
-
282
- 5. **Phase 0 - Research & Decisions**:
283
- - For each unknown research task
284
- - For each integration point compatibility analysis
285
- - Generate `$VIBE_DIR/specs/$BRANCH_NAME/technology-research.md` with decisions and rationale
286
-
287
- 6. **Phase 1 - High-Level Integration Design**:
288
- - Document how this feature integrates with existing architecture
289
- - Identify integration points and dependencies
290
- - Plan compatibility and migration requirements
291
-
292
- 7. **Integration Strategy**:
293
- - Plan how to integrate with existing codebase
294
- - Identify migration or compatibility requirements
295
- - Document rollout strategy if needed
263
+ **STEP 1: Load Context**
264
+ - Read the feature specification (`$VIBE_DIR/specs/$BRANCH_NAME/spec.md`)
265
+ - Read analysis findings (`$VIBE_DIR/specs/$BRANCH_NAME/current-state-analysis.md` if exists)
266
+ - Review existing project constitution or architectural principles
267
+ - Understand current system architecture and patterns
268
+
269
+ **STEP 2: Interactive Integration Planning**
270
+ Ask the user about:
271
+ - **Technology Consistency**: Should this use the same tech stack as existing features?
272
+ - **Architecture Alignment**: How should this fit into the current architecture?
273
+ - **Database Changes**: Any new data models or schema changes needed?
274
+
275
+ **STEP 3: Technical Context Analysis**
276
+ - Identify how this feature integrates with existing system
277
+ - Map dependencies and integration points
278
+ - Choose appropriate technology stack (consistent with existing)
279
+ - Mark unknowns as "NEEDS CLARIFICATION" for research
280
+
281
+ **STEP 4: Constitutional/Architectural Compliance**
282
+ - Evaluate approach against existing architectural principles
283
+ - Ensure consistency with current patterns and conventions
284
+ - Identify any violations and justify or resolve them
285
+
286
+ **STEP 5: Phase 0 - Research & Decisions**
287
+ - For each unknownresearch task
288
+ - For each integration point compatibility analysis
289
+ - Generate `$VIBE_DIR/specs/$BRANCH_NAME/technology-research.md` with decisions and rationale
290
+
291
+ **STEP 6: Phase 1 - High-Level Integration Design**
292
+ - Document how this feature integrates with existing architecture
293
+ - Identify integration points and dependencies
294
+ - Plan compatibility and migration requirements
295
+
296
+ **STEP 7: Integration Strategy**
297
+ - Plan how to integrate with existing codebase
298
+ - Identify migration or compatibility requirements
299
+ - Document rollout strategy if needed
296
300
 
297
301
  Create `$VIBE_DIR/specs/$BRANCH_NAME/plan.md` with complete implementation strategy that respects existing system architecture.
298
302
 
@@ -311,63 +315,65 @@ states:
311
315
  tasks:
312
316
  description: 'Generate actionable, dependency-ordered tasks organized by user stories'
313
317
  default_instructions: |
314
- You are generating actionable tasks organized by user stories for independent implementation.
318
+ Generate actionable tasks organized by user stories for independent implementation.
315
319
 
316
320
  **Task Generation Process:**
317
321
 
318
- 1. **Load Design Documents**:
319
- - **Required**: `$VIBE_DIR/specs/$BRANCH_NAME/plan.md`, `$VIBE_DIR/specs/$BRANCH_NAME/spec.md` (user stories with priorities)
320
- - **Optional**: `$VIBE_DIR/specs/$BRANCH_NAME/technology-research.md`, `$VIBE_DIR/specs/$BRANCH_NAME/current-state-analysis.md`
321
-
322
- 2. **Extract User Stories**: Load $VIBE_DIR/specs/$BRANCH_NAME/spec.md and extract user stories with priorities (P1, P2, P3...)
323
-
324
- 3. **Generate Tasks Organized by User Story**:
325
- - **Setup Phase**: Integration setup and shared infrastructure
326
- - **Foundational Phase**: Prerequisites for this feature (database changes, etc.)
327
- - **User Story Phases** (P1, P2, P3...): One phase per story in priority order
328
- - Group all tasks needed to complete JUST that story
329
- - Include models, services, endpoints, UI components specific to that story
330
- - Consider integration with existing components
331
- - Mark parallelizable tasks with [P]
332
- - Each story should be independently testable
333
-
334
- 4. **Integration Tasks**:
335
- - Tasks for connecting with existing system
336
- - Migration or compatibility tasks if needed
337
- - Testing integration points
338
-
339
- 5. **Task Rules**:
340
- - Different files/components = mark [P] for parallel execution
341
- - Same file = sequential (no [P])
342
- - Number tasks sequentially (T001, T002...)
343
- - Each task specific enough for LLM to complete
344
-
345
- 6. **Rollout Strategy**: Plan for gradual feature rollout if applicable
322
+ **STEP 1: Load Design Documents**
323
+ - **Required**: `$VIBE_DIR/specs/$BRANCH_NAME/plan.md`, `$VIBE_DIR/specs/$BRANCH_NAME/spec.md` (user stories with priorities)
324
+ - **Optional**: `$VIBE_DIR/specs/$BRANCH_NAME/technology-research.md`, `$VIBE_DIR/specs/$BRANCH_NAME/current-state-analysis.md`
325
+
326
+ **STEP 2: Extract User Stories**
327
+ Load `$VIBE_DIR/specs/$BRANCH_NAME/spec.md` and extract user stories with priorities (P1, P2, P3...)
328
+
329
+ **STEP 3: Generate Tasks Organized by User Story**
330
+ - **Setup Phase**: Integration setup and shared infrastructure
331
+ - **Foundational Phase**: Prerequisites for this feature (database changes, etc.)
332
+ - **User Story Phases** (P1, P2, P3...): One phase per story in priority order
333
+ - Group all tasks needed to complete JUST that story
334
+ - Include models, services, endpoints, UI components specific to that story
335
+ - Consider integration with existing components
336
+ - Mark parallelizable tasks with `[P]`
337
+ - Each story should be independently testable
338
+
339
+ **STEP 4: Integration Tasks**
340
+ - Tasks for connecting with existing system
341
+ - Migration or compatibility tasks if needed
342
+ - Testing integration points
343
+
344
+ **STEP 5: Apply Task Rules**
345
+ - Different files/components = mark `[P]` for parallel execution
346
+ - Same file = sequential (no `[P]`)
347
+ - Number tasks sequentially (T001, T002...)
348
+ - Ensure each task is specific enough for LLM to complete
349
+
350
+ **STEP 6: Rollout Strategy**
351
+ Plan for gradual feature rollout if applicable
346
352
 
347
353
  additional_instructions: |
348
354
  **Document Creation Instructions:**
349
355
 
350
356
  Create these documents in the following order:
351
357
 
352
- **1. Data Model (`$VIBE_DIR/specs/$BRANCH_NAME/data-model.md`)**:
358
+ **1. Data Model** (`$VIBE_DIR/specs/$BRANCH_NAME/data-model.md`)
353
359
  - Extract entities from the specification
354
360
  - Design data models that integrate with existing system
355
361
  - Document relationships with existing entities
356
362
  - Include migration requirements if needed
357
363
 
358
- **2. API Contracts (`$VIBE_DIR/specs/$BRANCH_NAME/contracts/`)**:
364
+ **2. API Contracts** (`$VIBE_DIR/specs/$BRANCH_NAME/contracts/`)
359
365
  - Design API contracts that integrate with existing system
360
366
  - Ensure compatibility with existing data models and APIs
361
367
  - Include versioning strategy if needed
362
368
  - Document integration points
363
369
 
364
- **3. Development Setup (`$VIBE_DIR/specs/$BRANCH_NAME/quickstart.md`)**:
370
+ **3. Development Setup** (`$VIBE_DIR/specs/$BRANCH_NAME/quickstart.md`)
365
371
  - Feature development setup instructions
366
372
  - Integration testing setup
367
373
  - Local development environment for this feature
368
374
  - Testing instructions specific to this feature
369
375
 
370
- **4. Task Breakdown (`$VIBE_DIR/specs/$BRANCH_NAME/tasks.md`)**:
376
+ **4. Task Breakdown** (`$VIBE_DIR/specs/$BRANCH_NAME/tasks.md`)
371
377
  Use this structure for the tasks file:
372
378
 
373
379
  ```markdown
@@ -415,25 +421,26 @@ states:
415
421
  implement:
416
422
  description: 'Execute implementation following the task breakdown'
417
423
  default_instructions: |
418
- You are implementing the feature by executing the tasks defined in `$VIBE_DIR/specs/$BRANCH_NAME/tasks.md`, ensuring proper integration with the existing system.
424
+ Execute the feature implementation by following the tasks defined in `$VIBE_DIR/specs/$BRANCH_NAME/tasks.md`, ensuring proper integration with the existing system.
419
425
 
420
426
  **Implementation Guidelines:**
421
- 1. **Follow Task Order**: Execute tasks respecting dependencies and integration requirements
422
- 2. **System Integration**: Ensure new code follows existing patterns and conventions
423
- 3. **User Story Focus**: Complete one user story at a time for incremental delivery
424
- 4. **Quality Gates**: Each user story must meet success criteria from specification
425
- 5. **Testing**: Test both new functionality and integration with existing features
426
- 6. **Documentation**: Update existing documentation as needed
427
-
428
- **Integration Considerations**:
427
+
428
+ - Follow task order respecting dependencies and integration requirements
429
+ - Ensure new code follows existing patterns and conventions
430
+ - Complete one user story at a time for incremental delivery
431
+ - Verify each user story meets success criteria from specification
432
+ - Test both new functionality and integration with existing features
433
+ - Update existing documentation as needed
434
+
435
+ **Integration Considerations:**
429
436
  - Follow existing code style and patterns
430
437
  - Respect current architectural decisions
431
438
  - Test integration points thoroughly
432
439
  - Consider backward compatibility
433
440
  - Update relevant configuration or setup
434
441
 
435
- **Progress Tracking**:
436
- - Mark completed tasks with [x] in `$VIBE_DIR/specs/$BRANCH_NAME/tasks.md`
442
+ **Progress Tracking:**
443
+ - Mark completed tasks with `[x]` in `$VIBE_DIR/specs/$BRANCH_NAME/tasks.md`
437
444
  - Document any integration challenges or decisions
438
445
  - Update specification if requirements evolve
439
446