@codemcp/workflows 6.0.3 → 6.1.0

package/resources/workflows/skilled-greenfield.yaml

@@ -0,0 +1,206 @@
+---
+name: 'skilled-greenfield'
+description: 'A comprehensive workflow for starting new projects from scratch: Ideation, Architecture, Plan, Code, Document - ideal for greenfield projects requiring thorough upfront planning'
+initial_state: 'ideation'
+
+# Enhanced metadata for better discoverability
+metadata:
+  domain: 'skilled'
+  complexity: 'high'
+  bestFor:
+    - 'New projects from scratch'
+    - 'Greenfield development'
+    - 'Complex system design'
+    - 'Comprehensive planning needed'
+  useCases:
+    - 'Starting a new application'
+    - 'Building a new service'
+    - 'Creating a new library'
+  examples:
+    - 'Build a new web application'
+    - 'Create a microservice architecture'
+    - 'Develop a new CLI tool'
+  requiresDocumentation: true
+
+# States with default instructions and transitions
+states:
+  ideation:
+    description: 'Deep requirements discovery and PRD creation phase'
+    default_instructions: |
+      Understand WHAT the system should do, WHO will use it, WHY it's needed, and WHAT'S in/out of scope by exploring:
+      - Are there existing solutions? What gaps do they have?
+      - What technologies must/cannot be used? Why?
+      - How will you measure product success?
+      - Have you validated this need with potential users?
+
+      Use the **starting-project** skill to understand how SAB projects are set up and what conventions and tooling to expect.
+
+      Don't discuss technical implementation yet - focus purely on understanding the problem space and requirements. Check whether there is a requirements document in the project and if so, read it carefully. Create tasks as needed.
+    transitions:
+      - trigger: 'ideation_complete'
+        to: 'architecture'
+        transition_reason: 'PRD is complete with clear requirements, ready for technical architecture design'
+        review_perspectives:
+          - perspective: 'business_analyst'
+            prompt: 'Review the Product Requirements Document for completeness, clarity, and business value. Ensure all stakeholder needs are captured, requirements are testable, and scope is well-defined.'
+          - perspective: 'ux_expert'
+            prompt: 'Evaluate user experience requirements and usability considerations. Ensure user personas, workflows, and interaction patterns are properly defined for the greenfield project.'
+
+  architecture:
+    description: 'Tech stack selection and architecture design phase'
+    default_instructions: |
+      Design the technical solution based on the requirements discovered during ideation.
+
+      - Ask about the user's technical preferences and experience
+      - Challenge their choices by presenting alternatives
+      - Evaluate pros and cons of different tech stacks, frameworks, and architectural patterns
+      - Consider non-functional requirements like scalability, performance, maintainability, and deployment
+      - Use the **architecture** skill to understand SAB architectural conventions and apply them to your design
+
+      Check whether there is an architecture document in the project and if so, read and build on it. Don't start coding yet - focus on technical design decisions.
+    transitions:
+      - trigger: 'need_more_ideation'
+        to: 'ideation'
+        additional_instructions: 'Architecture work revealed gaps in requirements understanding. Focus on the specific requirements areas that need clarification before continuing with technical design.'
+        transition_reason: 'Architecture work revealed need for more requirements clarification'
+
+      - trigger: 'architecture_complete'
+        to: 'plan'
+        additional_instructions: 'Present the implementation plan to the user and document it thoroughly.'
+        transition_reason: 'Technical architecture is complete, ready for implementation planning'
+        review_perspectives:
+          - perspective: 'architect'
+            prompt: 'Review the technical architecture for completeness, scalability, and maintainability. Ensure technology choices are appropriate and architectural patterns are sound for a greenfield project.'
+          - perspective: 'security_expert'
+            prompt: 'Evaluate security architecture, data protection strategies, and potential vulnerabilities. Ensure security is built into the foundation of the greenfield project from the start.'
+
+      - trigger: 'abandon_project'
+        to: 'ideation'
+        instructions: >
+          Project development abandoned during architecture phase. Return to ideation state for new projects.
+          Task history and PRD will remain for future reference.
+        additional_instructions: 'Project development abandoned during architecture phase. Clean up any architecture work and prepare for new projects.'
+        transition_reason: 'User decided to abandon project during architecture phase'
+
+  plan:
+    description: 'Implementation planning phase based on established architecture'
+    default_instructions: |
+      Create a detailed implementation strategy based on your completed architecture and requirements.
+
+      - Use the **application-design** skill when planning authentication, routing, error handling, or forms
+      - Check whether there is a design document in the project and adhere to it
+
+      **STEP 1: Break Down Work**
+      - Break down the work into specific, actionable tasks
+      - Consider the chosen tech stack and architectural decisions
+      - Plan the implementation order and identify dependencies
+
+      **STEP 2: Assess Risks**
+      - Consider potential risks and mitigation strategies
+      - Document the detailed design if needed
+
+      **STEP 3: Create Tasks**
+      - Create tasks thoroughly with clear milestones for implementation work
+      - Ensure each task is actionable and has clear acceptance criteria
+    transitions:
+      - trigger: 'need_architecture_changes'
+        to: 'architecture'
+        additional_instructions: "Planning revealed issues with the current architecture. Consider what you've learned during planning and adjust the technical design accordingly. Document the changes and reasons."
+        transition_reason: 'Planning work revealed need to revise the architecture'
+
+      - trigger: 'plan_complete'
+        to: 'code'
+        additional_instructions: "Implementation plan is complete! ✅ Now transition to coding phase. Read specific documentation before using the chosen libraries and frameworks. Follow the architectural patterns and tech stack decisions you've made. Modularize your code according to best practices. Stay focused on the current project scope defined in your PRD. Update task progress as you complete planning work."
+        transition_reason: 'Implementation plan is complete and ready for coding'
+
+      - trigger: 'abandon_project'
+        to: 'ideation'
+        instructions: >
+          Project development abandoned during planning. Return to ideation state for new projects.
+          Task history, PRD, and architecture documentation will remain for future reference.
+        additional_instructions: 'Project development abandoned during planning. Clean up any planning work and prepare for new projects.'
+        transition_reason: 'User decided to abandon project during planning phase'
+
+  code:
+    description: 'Implementation phase following the established plan and architecture'
+    default_instructions: |
+      Build the solution following your plan and architecture.
+
+      - Check whether there is a design document in the project and follow it
+      - Check whether there is a requirements document in the project and ensure all requirements you are currently working on are met
+      - Use the **coding** skill to implement components, styling, and coding patterns. Apply this skill to all coding tasks of this phase!
+      - Use the **testing** skill to write and run tests. Apply this skill to all test tasks of this phase!
+      - Write clean, well-structured code with proper error handling
+      - Prevent regression by building, linting, and executing existing tests
+      - Stay flexible and adapt the plan as you learn more during implementation, but maintain alignment with your architecture decisions
+      - Update task progress and create new tasks as needed for current phase work
+    transitions:
+      - trigger: 'need_replanning'
+        to: 'plan'
+        additional_instructions: "Implementation revealed issues with the current plan. Consider what you've learned during coding and adjust the implementation strategy accordingly while maintaining architectural consistency. Document the changes and reasons."
+        transition_reason: 'Implementation work revealed need to revise the plan'
+
+      - trigger: 'need_architecture_changes'
+        to: 'architecture'
+        additional_instructions: 'Implementation revealed fundamental issues with the architecture that require design changes. Focus on the specific architectural problems that are blocking implementation progress.'
+        transition_reason: 'Implementation work revealed need for architectural changes'
+
+      - trigger: 'code_complete'
+        to: 'finalize'
+        transition_reason: 'Core implementation is complete, ready for comprehensive documentation'
+
+      - trigger: 'abandon_project'
+        to: 'ideation'
+        instructions: >
+          Project development abandoned during implementation. Clean up any incomplete code and return to ideation.
+          Task history, PRD, architecture documentation, and any completed work will remain for future reference.
+        additional_instructions: 'Project development abandoned during implementation. Clean up any incomplete code and prepare for new projects.'
+        transition_reason: 'User decided to abandon project during implementation'
+
+  finalize:
+    description: 'Code cleanup and documentation finalization'
+    default_instructions: |
+      This phase ensures code quality and documentation accuracy through systematic cleanup and review.
+
+      **STEP 1: Code Cleanup**
+      Systematically clean up development artifacts:
+
+      1. Remove all temporary debug output statements used during development (console logging, print statements, debug functions)
+      2. Address each TODO/FIXME comment by either implementing the solution or documenting why it's deferred
+         - Remove completed TODOs
+         - Convert remaining TODOs to proper issue tracking if needed
+      3. Remove debugging code blocks, temporary test code, and commented-out code
+         - Ensure proper error handling replaces temporary debug logging
+
+      **STEP 2: Documentation Review**
+      Update documentation to reflect final implementation:
+
+      1. Check whether there is a requirements, architecture, or design document in the project and update any that are affected by the implementation
+      2. Review documentation against actual implemented functionality
+      3. Only modify documentation sections that have functional changes
+      4. Remove references to development iterations, progress notes, and temporary decisions
+      5. Ensure documentation describes the final implemented state, not the development process
+      6. Ask user to review document updates
+
+      **STEP 3: Comprehensive Documentation**
+      Ensure project has complete documentation for newcomers including setup, usage, architecture overview, and contribution guidelines.
+
+      **STEP 4: Final Validation**
+      - Use the **testing** skill to run and verify all tests
+      - Verify documentation accuracy with a final review
+      - Ensure project is ready for users and contributors
+      - Update task progress and mark completed work as you finalize the project
+    transitions:
+      - trigger: 'need_code_changes'
+        to: 'code'
+        additional_instructions: 'Finalization revealed issues that require code changes. Focus on the problems identified during final review that affect usability or functionality.'
+        transition_reason: 'Finalization revealed issues requiring code changes'
+
+      - trigger: 'finalization_complete'
+        to: 'ideation'
+        transition_reason: 'Project delivery complete with finalized code and documentation, ready for next greenfield project'
+
+      - trigger: 'abandon_project'
+        to: 'ideation'
+        additional_instructions: 'Project development abandoned during finalization. Clean up any finalization artifacts and prepare for new projects.'
+        transition_reason: 'User decided to abandon project during finalization phase'