|
| 1 | +# Implementation Plans |
| 2 | + |
| 3 | +This directory contains detailed implementation plans for complex changes that require multiple steps to complete. |
| 4 | + |
| 5 | +## Purpose |
| 6 | + |
| 7 | +When working on issues that involve: |
| 8 | + |
| 9 | +- Significant architectural refactoring |
| 10 | +- Multiple phases with dependencies |
| 11 | +- Changes spanning many files across different layers |
| 12 | +- Complex coordination between features |
| 13 | + |
| 14 | +...we create detailed implementation plans here to: |
| 15 | + |
| 16 | +- Track progress systematically |
| 17 | +- Enable incremental commits with validation |
| 18 | +- Document decision rationale for each step |
| 19 | +- Provide clear recovery points if issues arise |
| 20 | + |
| 21 | +## Difference from Other Documentation |
| 22 | + |
| 23 | +- **`docs/roadmap/`**: High-level planned features and long-term vision |
| 24 | +- **`docs/refactors/`**: Planned large-scale refactoring initiatives |
| 25 | +- **`docs/implementation-plans/`**: Step-by-step execution plans for specific issues |
| 26 | + |
| 27 | +## Structure |
| 28 | + |
| 29 | +Each implementation plan document should include: |
| 30 | + |
| 31 | +1. **Context**: Brief description of the issue and why the plan is needed |
| 32 | +2. **Problem Analysis**: Architectural or technical issues being addressed |
| 33 | +3. **Progress Tracking**: Checklist of all steps with completion status |
| 34 | +4. **Phase Breakdown**: Logical grouping of related steps |
| 35 | +5. **Detailed Steps**: For each step: |
| 36 | + - Clear commit message format |
| 37 | + - Specific actions to take |
| 38 | + - Files to create/modify/delete |
| 39 | + - Pre-commit protocol (tests + linters) |
| 40 | + - Time estimates |
| 41 | + |
| 42 | +## Naming Convention |
| 43 | + |
| 44 | +Files should be named: `issue-{number}-{short-description}.md` |
| 45 | + |
| 46 | +Examples: |
| 47 | + |
| 48 | +- `issue-220-test-command-architecture.md` |
| 49 | +- `issue-315-database-migration-strategy.md` |
| 50 | + |
| 51 | +## Workflow |
| 52 | + |
| 53 | +1. Create the plan when issue complexity becomes apparent |
| 54 | +2. Review and refine the plan before implementation |
| 55 | +3. Follow the plan step-by-step with incremental commits |
| 56 | +4. Update progress tracking as steps complete |
| 57 | +5. Keep the plan updated if changes are needed during implementation |
| 58 | +6. Archive completed plans in this directory for future reference |
0 commit comments