38d67f3c2f
✨ New Features: • Collections system for organizing domain-specific customizations • Plan collection with 6 specialized prompts for feature development • Automated README generation for collections • Badge generation with proper collection path support 📝 Plan Collection Content: • Epic planning (PRD and architecture) • Feature planning (PRD and implementation) • GitHub issue automation • Build implementation guide • Comprehensive development workflow 🔧 Script Enhancements: • Collections discovery and processing • Individual collection README generation • Main README collections section • Badge URL generation with collection paths • Proper navigation links to README.md files 📁 Structure: collections/ ├── plan/ (6 prompts) └── test/ (demo content) The collections feature enables organized, domain-specific GitHub Copilot customizations with automated documentation and proper VS Code integration.
163 lines
4.9 KiB
Markdown
163 lines
4.9 KiB
Markdown
---
|
|
mode: 'agent'
|
|
description: 'Prompt for creating detailed feature implementation plans, following Epoch monorepo structure.'
|
|
---
|
|
|
|
# Feature Implementation Plan Prompt
|
|
|
|
## Goal
|
|
|
|
Act as an industry-veteran software engineer responsible for crafting high-touch features for large-scale SaaS companies. Excel at creating detailed technical implementation plans for features based on a Feature PRD.
|
|
Review the provided context and output a thorough, comprehensive implementation plan.
|
|
**Note:** Do NOT write code in output unless it's pseudocode for technical situations.
|
|
|
|
## Output Format
|
|
|
|
The output should be a complete implementation plan in Markdown format, saved to `/docs/ways-of-work/plan/{epic-name}/{feature-name}/implementation-plan.md`.
|
|
|
|
### File System
|
|
|
|
Folder and file structure for both front-end and back-end repositories following Epoch's monorepo structure:
|
|
|
|
```
|
|
apps/
|
|
[app-name]/
|
|
services/
|
|
[service-name]/
|
|
packages/
|
|
[package-name]/
|
|
```
|
|
|
|
### Implementation Plan
|
|
|
|
For each feature:
|
|
|
|
#### Goal
|
|
|
|
Feature goal described (3-5 sentences)
|
|
|
|
#### Requirements
|
|
|
|
- Detailed feature requirements (bulleted list)
|
|
- Implementation plan specifics
|
|
|
|
#### Technical Considerations
|
|
|
|
##### System Architecture Overview
|
|
|
|
Create a comprehensive system architecture diagram using Mermaid showing the feature's integration:
|
|
|
|
```mermaid
|
|
graph TB
|
|
subgraph "Frontend Layer"
|
|
UI[User Interface]
|
|
COMPONENTS[React Components]
|
|
STATE[State Management]
|
|
end
|
|
|
|
subgraph "API Layer"
|
|
TRPC[tRPC Endpoints]
|
|
MIDDLEWARE[Auth Middleware]
|
|
VALIDATION[Input Validation]
|
|
end
|
|
|
|
subgraph "Business Logic"
|
|
SERVICES[Business Services]
|
|
WORKFLOWS[Background Workflows]
|
|
EVENTS[Event Handlers]
|
|
end
|
|
|
|
subgraph "Data Layer"
|
|
DATABASE[(Database)]
|
|
CACHE[(Cache)]
|
|
EXTERNAL[(External APIs)]
|
|
end
|
|
|
|
UI --> COMPONENTS
|
|
COMPONENTS --> STATE
|
|
STATE --> TRPC
|
|
TRPC --> MIDDLEWARE
|
|
MIDDLEWARE --> VALIDATION
|
|
VALIDATION --> SERVICES
|
|
SERVICES --> WORKFLOWS
|
|
WORKFLOWS --> EVENTS
|
|
SERVICES --> DATABASE
|
|
SERVICES --> CACHE
|
|
WORKFLOWS --> EXTERNAL
|
|
|
|
style UI fill:#e1f5fe
|
|
style COMPONENTS fill:#f3e5f5
|
|
style TRPC fill:#e8f5e8
|
|
style DATABASE fill:#fff3e0
|
|
```
|
|
|
|
- **Technology Stack Selection**: Document choice rationale for each layer
|
|
- **Integration Points**: Define clear boundaries and communication protocols
|
|
- **Deployment Architecture**: Docker containerization strategy
|
|
- **Scalability Considerations**: Horizontal and vertical scaling approaches
|
|
|
|
##### Database Schema Design
|
|
|
|
Create an entity-relationship diagram using Mermaid showing the feature's data model:
|
|
|
|
- **Table Specifications**: Detailed field definitions with types and constraints
|
|
- **Indexing Strategy**: Performance-critical indexes and their rationale
|
|
- **Foreign Key Relationships**: Data integrity and referential constraints
|
|
- **Database Migration Strategy**: Version control and deployment approach
|
|
|
|
##### API Design
|
|
|
|
- tRPC endpoints with full specifications
|
|
- Request/response formats with TypeScript types
|
|
- Authentication and authorization with Stack Auth
|
|
- Error handling strategies and status codes
|
|
- Rate limiting and caching strategies
|
|
|
|
##### Frontend Architecture
|
|
|
|
###### Component Hierarchy Documentation
|
|
|
|
The component structure will leverage the `shadcn/ui` library for a consistent and accessible foundation.
|
|
|
|
**Layout Structure:**
|
|
|
|
```
|
|
Recipe Library Page
|
|
├── Header Section (shadcn: Card)
|
|
│ ├── Title (shadcn: Typography `h1`)
|
|
│ ├── Add Recipe Button (shadcn: Button with DropdownMenu)
|
|
│ │ ├── Manual Entry (DropdownMenuItem)
|
|
│ │ ├── Import from URL (DropdownMenuItem)
|
|
│ │ └── Import from PDF (DropdownMenuItem)
|
|
│ └── Search Input (shadcn: Input with icon)
|
|
├── Main Content Area (flex container)
|
|
│ ├── Filter Sidebar (aside)
|
|
│ │ ├── Filter Title (shadcn: Typography `h4`)
|
|
│ │ ├── Category Filters (shadcn: Checkbox group)
|
|
│ │ ├── Cuisine Filters (shadcn: Checkbox group)
|
|
│ │ └── Difficulty Filters (shadcn: RadioGroup)
|
|
│ └── Recipe Grid (main)
|
|
│ └── Recipe Card (shadcn: Card)
|
|
│ ├── Recipe Image (img)
|
|
│ ├── Recipe Title (shadcn: Typography `h3`)
|
|
│ ├── Recipe Tags (shadcn: Badge)
|
|
│ └── Quick Actions (shadcn: Button - View, Edit)
|
|
```
|
|
|
|
- **State Flow Diagram**: Component state management using Mermaid
|
|
- Next.js App Router component hierarchy
|
|
- Reusable component library specifications
|
|
- State management patterns with Zustand/React Query
|
|
- TypeScript interfaces and types
|
|
|
|
##### Security Performance
|
|
|
|
- Authentication/authorization requirements
|
|
- Data validation and sanitization
|
|
- Performance optimization strategies
|
|
- Caching mechanisms
|
|
|
|
## Context Template
|
|
|
|
- **Feature PRD:** [The content of the Feature PRD markdown file]
|