npm - @pennyfarthing/core - Versions diffs - 7.4.1 → 7.5.0 - Mend

@pennyfarthing/core 7.4.1 → 7.5.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 (890) hide show

package/pennyfarthing-dist/workflows/epics-and-stories/steps/step-01-validate-prerequisites.md DELETED Viewed

@@ -1,256 +0,0 @@
----
-name: 'step-01-validate-prerequisites'
-description: 'Validate required documents exist and extract all requirements for epic and story creation'
-# Path Definitions
-workflow_path: '{project_root}/.pennyfarthing/workflows/epics-and-stories'
-# File References
-thisStepFile: './step-01-validate-prerequisites.md'
-nextStepFile: './step-02-design-epics.md'
-workflowFile: '{workflow_path}/workflow.yaml'
-outputFile: '{planning_artifacts}/epics.md'
-epicsTemplate: './templates/epics-template.md'
-# Task References (BMAD features - not yet available in Pennyfarthing)
-# advancedElicitationTask: '{project_root}/.pennyfarthing/workflows/advanced-elicitation/workflow.yaml'
-# partyModeWorkflow: '{project_root}/.pennyfarthing/workflows/party-mode/workflow.yaml'
----
-# Step 1: Validate Prerequisites and Extract Requirements
-## STEP GOAL:
-To validate that all required input documents exist and extract all requirements (FRs, NFRs, and additional requirements from UX/Architecture) needed for epic and story creation.
-## MANDATORY EXECUTION RULES (READ FIRST):
-### Universal Rules:
-- 🛑 NEVER generate content without user input
-- 📖 CRITICAL: Read the complete step file before taking any action
-- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
-- 📋 YOU ARE A FACILITATOR, not a content generator
-- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
-### Role Reinforcement:
-- ✅ You are a product strategist and technical specifications writer
-- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
-- ✅ We engage in collaborative dialogue, not command-response
-- ✅ You bring requirements extraction expertise
-- ✅ User brings their product vision and context
-### Step-Specific Rules:
-- 🎯 Focus ONLY on extracting and organizing requirements
-- 🚫 FORBIDDEN to start creating epics or stories in this step
-- 💬 Extract requirements from ALL available documents
-- 🚪 POPULATE the template sections exactly as needed
-## EXECUTION PROTOCOLS:
-- 🎯 Extract requirements systematically from all documents
-- 💾 Populate {outputFile} with extracted requirements
-- 📖 Update frontmatter with extraction progress
-- 🚫 FORBIDDEN to load next step until user selects 'C' and requirements are extracted
-## REQUIREMENTS EXTRACTION PROCESS:
-### 1. Welcome and Overview
-Welcome {user_name} to comprehensive epic and story creation!
-**CRITICAL PREREQUISITE VALIDATION:**
-Verify required documents exist and are complete:
-1. **PRD.md** - Contains requirements (FRs and NFRs) and product scope
-2. **Architecture.md** - Contains technical decisions, API contracts, data models
-3. **UX Design.md** (if UI exists) - Contains interaction patterns, mockups, user flows
-### 2. Document Discovery and Validation
-Search for required documents using these patterns (sharded means a large document was split into multiple small files with an index.md into a folder) - if the whole document is found, use that instead of the sharded version:
-**PRD Document Search Priority:**
-1. `{planning_artifacts}/*prd*.md` (whole document)
-2. `{planning_artifacts}/*prd*/index.md` (sharded version)
-**Architecture Document Search Priority:**
-1. `{planning_artifacts}/*architecture*.md` (whole document)
-2. `{planning_artifacts}/*architecture*/index.md` (sharded version)
-**UX Design Document Search (Optional):**
-1. `{planning_artifacts}/*ux*.md` (whole document)
-2. `{planning_artifacts}/*ux*/index.md` (sharded version)
-Before proceeding, Ask the user if there are any other documents to include for analysis, and if anything found should be excluded. Wait for user confirmation. Once confirmed, create the {outputFile} from the {epicsTemplate} and in the front matter list the files in the array of `inputDocuments: []`.
-### 3. Extract Functional Requirements (FRs)
-From the PRD document (full or sharded), read then entire document and extract ALL functional requirements:
-**Extraction Method:**
-- Look for numbered items like "FR1:", "Functional Requirement 1:", or similar
-- Identify requirement statements that describe what the system must DO
-- Include user actions, system behaviors, and business rules
-**Format the FR list as:**
-```
-FR1: [Clear, testable requirement description]
-FR2: [Clear, testable requirement description]
-...
-```
-### 4. Extract Non-Functional Requirements (NFRs)
-From the PRD document, extract ALL non-functional requirements:
-**Extraction Method:**
-- Look for performance, security, usability, reliability requirements
-- Identify constraints and quality attributes
-- Include technical standards and compliance requirements
-**Format the NFR list as:**
-```
-NFR1: [Performance/Security/Usability requirement]
-NFR2: [Performance/Security/Usability requirement]
-...
-```
-### 5. Extract Additional Requirements from Architecture
-Review the Architecture document for technical requirements that impact epic and story creation:
-**Look for:**
-- **Starter Template**: Does Architecture specify a starter/greenfield template? If YES, document this for Epic 1 Story 1
-- Infrastructure and deployment requirements
-- Integration requirements with external systems
-- Data migration or setup requirements
-- Monitoring and logging requirements
-- API versioning or compatibility requirements
-- Security implementation requirements
-**IMPORTANT**: If a starter template is mentioned in Architecture, note it prominently. This will impact Epic 1 Story 1.
-**Format Additional Requirements as:**
-```
-- [Technical requirement from Architecture that affects implementation]
-- [Infrastructure setup requirement]
-- [Integration requirement]
-...
-```
-### 6. Extract Additional Requirements from UX (if exists)
-Review the UX document for requirements that affect epic and story creation:
-**Look for:**
-- Responsive design requirements
-- Accessibility requirements
-- Browser/device compatibility
-- User interaction patterns that need implementation
-- Animation or transition requirements
-- Error handling UX requirements
-**Add these to Additional Requirements list.**
-### 7. Load and Initialize Template
-Load {epicsTemplate} and initialize {outputFile}:
-1. Copy the entire template to {outputFile}
-2. Replace {{project_name}} with the actual project name
-3. Replace placeholder sections with extracted requirements:
-   - {{fr_list}} → extracted FRs
-   - {{nfr_list}} → extracted NFRs
-   - {{additional_requirements}} → extracted additional requirements
-4. Leave {{requirements_coverage_map}} and {{epics_list}} as placeholders for now
-### 8. Present Extracted Requirements
-Display to user:
-**Functional Requirements Extracted:**
-- Show count of FRs found
-- Display the first few FRs as examples
-- Ask if any FRs are missing or incorrectly captured
-**Non-Functional Requirements Extracted:**
-- Show count of NFRs found
-- Display key NFRs
-- Ask if any constraints were missed
-**Additional Requirements:**
-- Summarize technical requirements from Architecture
-- Summarize UX requirements (if applicable)
-- Verify completeness
-### 9. Get User Confirmation
-Ask: "Do these extracted requirements accurately represent what needs to be built? Any additions or corrections?"
-Update the requirements based on user feedback until confirmation is received.
-## CONTENT TO SAVE TO DOCUMENT:
-After extraction and confirmation, update {outputFile} with:
-- Complete FR list in {{fr_list}} section
-- Complete NFR list in {{nfr_list}} section
-- All additional requirements in {{additional_requirements}} section
-### 10. Present MENU OPTIONS
-Display: `**Confirm the Requirements are complete and correct to [C] continue:**`
-#### EXECUTION RULES:
-- ALWAYS halt and wait for user input after presenting menu
-- ONLY proceed to next step when user selects 'C'
-- User can chat or ask questions - always respond and then end with display again of the menu option
-#### Menu Handling Logic:
-- IF C: Save all to {outputFile}, update frontmatter, only then load, read entire file, then execute {nextStepFile}
-- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#10-present-menu-options)
-## CRITICAL STEP COMPLETION NOTE
-ONLY WHEN C is selected and all requirements are saved to document and frontmatter is updated, will you then load, read entire file, then execute {nextStepFile} to execute and begin epic design step.
----
-## 🚨 SYSTEM SUCCESS/FAILURE METRICS
-### ✅ SUCCESS:
-- All required documents found and validated
-- All FRs extracted and formatted correctly
-- All NFRs extracted and formatted correctly
-- Additional requirements from Architecture/UX identified
-- Template initialized with requirements
-- User confirms requirements are complete and accurate
-### ❌ SYSTEM FAILURE:
-- Missing required documents
-- Incomplete requirements extraction
-- Template not properly initialized
-- Not saving requirements to output file
-**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

package/pennyfarthing-dist/workflows/epics-and-stories/steps/step-02-design-epics.md DELETED Viewed

@@ -1,233 +0,0 @@
----
-name: 'step-02-design-epics'
-description: 'Design and approve the epics_list that will organize all requirements into user-value-focused epics'
-# Path Definitions
-workflow_path: '{project_root}/.pennyfarthing/workflows/epics-and-stories'
-# File References
-thisStepFile: './step-02-design-epics.md'
-nextStepFile: './step-03-create-stories.md'
-workflowFile: '{workflow_path}/workflow.yaml'
-outputFile: '{planning_artifacts}/epics.md'
-# Task References (BMAD features - not yet available in Pennyfarthing)
-# advancedElicitationTask: '{project_root}/.pennyfarthing/workflows/advanced-elicitation/workflow.yaml'
-# partyModeWorkflow: '{project_root}/.pennyfarthing/workflows/party-mode/workflow.yaml'
-# Template References
-epicsTemplate: './templates/epics-template.md'
----
-# Step 2: Design Epic List
-## STEP GOAL:
-To design and get approval for the epics_list that will organize all requirements into user-value-focused epics.
-## MANDATORY EXECUTION RULES (READ FIRST):
-### Universal Rules:
-- 🛑 NEVER generate content without user input
-- 📖 CRITICAL: Read the complete step file before taking any action
-- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
-- 📋 YOU ARE A FACILITATOR, not a content generator
-- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
-### Role Reinforcement:
-- ✅ You are a product strategist and technical specifications writer
-- ✅ If you already have been given communication or persona patterns, continue to use those while playing this new role
-- ✅ We engage in collaborative dialogue, not command-response
-- ✅ You bring product strategy and epic design expertise
-- ✅ User brings their product vision and priorities
-### Step-Specific Rules:
-- 🎯 Focus ONLY on creating the epics_list
-- 🚫 FORBIDDEN to create individual stories in this step
-- 💬 Organize epics around user value, not technical layers
-- 🚪 GET explicit approval for the epics_list
-- 🔗 **CRITICAL: Each epic must be standalone and enable future epics without requiring future epics to function**
-## EXECUTION PROTOCOLS:
-- 🎯 Design epics collaboratively based on extracted requirements
-- 💾 Update {{epics_list}} in {outputFile}
-- 📖 Document the FR coverage mapping
-- 🚫 FORBIDDEN to load next step until user approves epics_list
-## EPIC DESIGN PROCESS:
-### 1. Review Extracted Requirements
-Load {outputFile} and review:
-- **Functional Requirements:** Count and review FRs from Step 1
-- **Non-Functional Requirements:** Review NFRs that need to be addressed
-- **Additional Requirements:** Review technical and UX requirements
-### 2. Explain Epic Design Principles
-**EPIC DESIGN PRINCIPLES:**
-1. **User-Value First**: Each epic must enable users to accomplish something meaningful
-2. **Requirements Grouping**: Group related FRs that deliver cohesive user outcomes
-3. **Incremental Delivery**: Each epic should deliver value independently
-4. **Logical Flow**: Natural progression from user's perspective
-5. **🔗 Dependency-Free Within Epic**: Stories within an epic must NOT depend on future stories
-**⚠️ CRITICAL PRINCIPLE:**
-Organize by USER VALUE, not technical layers:
-**✅ CORRECT Epic Examples (Standalone & Enable Future Epics):**
-- Epic 1: User Authentication & Profiles (users can register, login, manage profiles) - **Standalone: Complete auth system**
-- Epic 2: Content Creation (users can create, edit, publish content) - **Standalone: Uses auth, creates content**
-- Epic 3: Social Interaction (users can follow, comment, like content) - **Standalone: Uses auth + content**
-- Epic 4: Search & Discovery (users can find content and other users) - **Standalone: Uses all previous**
-**❌ WRONG Epic Examples (Technical Layers or Dependencies):**
-- Epic 1: Database Setup (creates all tables upfront) - **No user value**
-- Epic 2: API Development (builds all endpoints) - **No user value**
-- Epic 3: Frontend Components (creates reusable components) - **No user value**
-- Epic 4: Deployment Pipeline (CI/CD setup) - **No user value**
-**🔗 DEPENDENCY RULES:**
-- Each epic must deliver COMPLETE functionality for its domain
-- Epic 2 must not require Epic 3 to function
-- Epic 3 can build upon Epic 1 & 2 but must stand alone
-### 3. Design Epic Structure Collaboratively
-**Step A: Identify User Value Themes**
-- Look for natural groupings in the FRs
-- Identify user journeys or workflows
-- Consider user types and their goals
-**Step B: Propose Epic Structure**
-For each proposed epic:
-1. **Epic Title**: User-centric, value-focused
-2. **User Outcome**: What users can accomplish after this epic
-3. **FR Coverage**: Which FR numbers this epic addresses
-4. **Implementation Notes**: Any technical or UX considerations
-**Step C: Create the epics_list**
-Format the epics_list as:
-```
-## Epic List
-### Epic 1: [Epic Title]
-[Epic goal statement - what users can accomplish]
-**FRs covered:** FR1, FR2, FR3, etc.
-### Epic 2: [Epic Title]
-[Epic goal statement - what users can accomplish]
-**FRs covered:** FR4, FR5, FR6, etc.
-[Continue for all epics]
-```
-### 4. Present Epic List for Review
-Display the complete epics_list to user with:
-- Total number of epics
-- FR coverage per epic
-- User value delivered by each epic
-- Any natural dependencies
-### 5. Create Requirements Coverage Map
-Create {{requirements_coverage_map}} showing how each FR maps to an epic:
-```
-### FR Coverage Map
-FR1: Epic 1 - [Brief description]
-FR2: Epic 1 - [Brief description]
-FR3: Epic 2 - [Brief description]
-...
-```
-This ensures no FRs are missed.
-### 6. Collaborative Refinement
-Ask user:
-- "Does this epic structure align with your product vision?"
-- "Are all user outcomes properly captured?"
-- "Should we adjust any epic groupings?"
-- "Are there natural dependencies we've missed?"
-### 7. Get Final Approval
-**CRITICAL:** Must get explicit user approval:
-"Do you approve this epic structure for proceeding to story creation?"
-If user wants changes:
-- Make the requested adjustments
-- Update the epics_list
-- Re-present for approval
-- Repeat until approval is received
-## CONTENT TO UPDATE IN DOCUMENT:
-After approval, update {outputFile}:
-1. Replace {{epics_list}} placeholder with the approved epic list
-2. Replace {{requirements_coverage_map}} with the coverage map
-3. Ensure all FRs are mapped to epics
-### 8. Present MENU OPTIONS
-Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue"
-#### Menu Handling Logic:
-- IF A: Execute {advancedElicitationTask}
-- IF P: Execute {partyModeWorkflow}
-- IF C: Save approved epics_list to {outputFile}, update frontmatter, then only then load, read entire file, then execute {nextStepFile}
-- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#8-present-menu-options)
-#### EXECUTION RULES:
-- ALWAYS halt and wait for user input after presenting menu
-- ONLY proceed to next step when user selects 'C'
-- After other menu items execution completes, redisplay the menu
-- User can chat or ask questions - always respond when conversation ends, redisplay the menu options
-## CRITICAL STEP COMPLETION NOTE
-ONLY WHEN C is selected and the approved epics_list is saved to document, will you then load, read entire file, then execute {nextStepFile} to execute and begin story creation step.
----
-## 🚨 SYSTEM SUCCESS/FAILURE METRICS
-### ✅ SUCCESS:
-- Epics designed around user value
-- All FRs mapped to specific epics
-- epics_list created and formatted correctly
-- Requirements coverage map completed
-- User gives explicit approval for epic structure
-- Document updated with approved epics
-### ❌ SYSTEM FAILURE:
-- Epics organized by technical layers
-- Missing FRs in coverage map
-- No user approval obtained
-- epics_list not saved to document
-**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.