mirror of
https://github.com/coleam00/Archon.git
synced 2025-12-23 18:29:18 -05:00
4.6 KiB
4.6 KiB
Feature Planning
Create a new plan in PRPs/specs/*.md to implement the Feature using the exact specified markdown Plan Format. Follow the Instructions to create the plan use the Relevant Files to focus on the right files.
Instructions
- IMPORTANT: You're writing a plan to implement a net new feature based on the
Featurethat will add value to the application. - IMPORTANT: The
Featuredescribes the feature that will be implemented but remember we're not implementing a new feature, we're creating the plan that will be used to implement the feature based on thePlan Formatbelow. - Create the plan in the
PRPs/specs/*.mdfile. Name it appropriately based on theFeature. - Use the
Plan Formatbelow to create the plan. - Research the codebase to understand existing patterns, architecture, and conventions before planning the feature.
- IMPORTANT: Replace every in the
Plan Formatwith the requested value. Add as much detail as needed to implement the feature successfully. - Use your reasoning model: THINK HARD about the feature requirements, design, and implementation approach.
- Follow existing patterns and conventions in the codebase. Don't reinvent the wheel.
- Design for extensibility and maintainability.
- If you need a new library, use
uv addand be sure to report it in theNotessection of thePlan Format. - Respect requested files in the
Relevant Filessection. - Start your research by reading the
README.mdfile. - ultrathink about the research before you create the plan.
Relevant Files
Focus on the following files:
README.md- Contains the project overview and instructions.app/server/**- Contains the codebase server.app/client/**- Contains the codebase client.scripts/**- Contains the scripts to start and stop the server + client.adws/**- Contains the AI Developer Workflow (ADW) scripts.
Ignore all other files in the codebase.
Plan Format
# Feature: <feature name>
## Feature Description
<describe the feature in detail, including its purpose and value to users>
## User Story
As a <type of user>
I want to <action/goal>
So that <benefit/value>
## Problem Statement
<clearly define the specific problem or opportunity this feature addresses>
## Solution Statement
<describe the proposed solution approach and how it solves the problem>
## Relevant Files
Use these files to implement the feature:
<find and list the files that are relevant to the feature describe why they are relevant in bullet points. If there are new files that need to be created to implement the feature, list them in an h3 'New Files' section.>
## Implementation Plan
### Phase 1: Foundation
<describe the foundational work needed before implementing the main feature>
### Phase 2: Core Implementation
<describe the main implementation work for the feature>
### Phase 3: Integration
<describe how the feature will integrate with existing functionality>
## Step by Step Tasks
IMPORTANT: Execute every step in order, top to bottom.
<list step by step tasks as h3 headers plus bullet points. use as many h3 headers as needed to implement the feature. Order matters, start with the foundational shared changes required then move on to the specific implementation. Include creating tests throughout the implementation process. Your last step should be running the `Validation Commands` to validate the feature works correctly with zero regressions.>
## Testing Strategy
### Unit Tests
<describe unit tests needed for the feature>
### Integration Tests
<describe integration tests needed for the feature>
### Edge Cases
<list edge cases that need to be tested>
## Acceptance Criteria
<list specific, measurable criteria that must be met for the feature to be considered complete>
## Validation Commands
Execute every command to validate the feature works correctly with zero regressions.
<list commands you'll use to validate with 100% confidence the feature is implemented correctly with zero regressions. every command must execute without errors so be specific about what you want to run to validate the feature works as expected. Include commands to test the feature end-to-end.>
- `cd app/server && uv run pytest` - Run server tests to validate the feature works with zero regressions
## Notes
<optionally list any additional notes, future considerations, or context that are relevant to the feature that will be helpful to the developer>
Feature
$ARGUMENTS
Report
- Summarize the work you've just done in a concise bullet point list.
- Include a path to the plan you created in the
PRPs/specs/*.mdfile.