Skip to content

TEMPLATE.md

Latest commit

 

History

History
186 lines (118 loc) · 3.92 KB

TEMPLATE.md

File metadata and controls

186 lines (118 loc) · 3.92 KB

[Refactoring Title]

📋 Overview

[Brief summary of what this refactoring addresses - goals, scope, and target files/components]

Target Files:

  • path/to/file1.rs
  • path/to/file2.rs

Scope:

  • [Scope item 1]
  • [Scope item 2]
  • [Scope item 3]

📊 Progress Tracking

Total Active Proposals: X Total Postponed: X Total Discarded: X Completed: X In Progress: X Not Started: X

Phase Summary

  • Phase 0 - [Phase Name] ([Impact], [Effort]): ⏳ X/X completed (XX%)
  • Phase 1 - [Phase Name] ([Impact], [Effort]): ⏳ X/X completed (XX%)
  • Phase 2 - [Phase Name] ([Impact], [Effort]): ⏳ X/X completed (XX%)

Discarded Proposals

[List any proposals that were considered but ultimately discarded, with brief rationale]

Postponed Proposals

[List any proposals that are deferred for later, with brief rationale and conditions for revisiting]

🎯 Key Problems Identified

1. [Problem Category]

[Description of the problem]

2. [Problem Category]

[Description of the problem]

3. [Problem Category]

[Description of the problem]

🚀 Refactoring Phases

Phase 0: [Phase Name] (Highest Priority)

[Description of why this phase should be done first]

Proposal #0: [Proposal Title]

Status: ⏳ Not Started / 🚧 In Progress / ✅ Completed
Impact: 🟢🟢🟢 High / 🟢🟢 Medium / 🟢 Low
Effort: 🔵 Low / 🔵🔵 Medium / 🔵🔵🔵 High
Priority: P0
Depends On: [Proposal #X] (if applicable)
Completed: [Date] (if completed)
Commit: [commit hash] (if completed)

Problem

[Clear description of the issue this proposal addresses, with code examples if helpful]

// Example of problematic code

Proposed Solution

[Detailed solution with code examples showing the improved approach]

// Example of improved code

Rationale

[Explanation of why this solution was chosen, alternatives considered, and design decisions]

Benefits

  • ✅ [Benefit 1]
  • ✅ [Benefit 2]
  • ✅ [Benefit 3]

Implementation Checklist

  • [Implementation step 1]
  • [Implementation step 2]
  • [Implementation step 3]
  • Verify all tests pass
  • Run linter and fix any issues
  • Update documentation

Testing Strategy

[Description of how to test these changes]

Results (if completed)

  • Lines Removed: X
  • Lines Added: X
  • Net Change: ±X lines
  • Tests: [Status]
  • Linters: [Status]

Phase 1: [Phase Name]

[Description of this phase's focus]

Proposal #1: [Proposal Title]

Status: ⏳ Not Started
Impact: 🟢🟢 Medium
Effort: 🔵🔵 Medium
Priority: P1
Depends On: [Proposal #X] (if applicable)

[Follow same structure as Proposal #0]

Phase 2: [Phase Name]

[Description of this phase's focus]

Proposal #N: [Proposal Title]

[Follow same structure as previous proposals]

📈 Timeline

  • Start Date: [Date]
  • Actual Completion: [Date] (if completed)

🔍 Review Process

Approval Criteria

  • All proposals reviewed by [reviewer names]
  • Technical feasibility validated
  • Aligns with Development Principles
  • Implementation plan is clear and actionable

Completion Criteria

  • All active proposals implemented
  • All tests passing
  • All linters passing
  • Documentation updated
  • Code reviewed and approved
  • Changes merged to main branch

📚 Related Documentation

💡 Notes

[Any additional notes, observations, or lessons learned during the refactoring]

Created: [Date]
Last Updated: [Date]
Status: 📋 Planning / 🚧 In Progress / ✅ Completed / ⏸️ Paused / ❌ Cancelled