Home/prompts/Refactor Plan

Refactor Plan

Plan a multi-file refactor with proper sequencing and rollback steps

CopilotpromptBuilt-inFeatured

Refactor Plan

Create a detailed plan for this refactoring task.

Refactor Goal

{{refactor_description}}

Instructions

  • Search the codebase to understand current state
  • Identify all affected files and their dependencies
  • Plan changes in a safe sequence (types first, then implementations, then tests)
  • Include verification steps between changes
  • Consider rollback if something fails
  • Output Format

    ## Refactor Plan: [title]
    
    

    Current State

    [Brief description of how things work now]

    Target State

    [Brief description of how things will work after]

    Affected Files

    | File | Change Type | Dependencies |

    |------|-------------|--------------|

    | path | modify/create/delete | blocks X, blocked by Y |

    Execution Plan

    #### Phase 1: Types and Interfaces

    • [ ] Step 1.1: [action] in file.ts
    • [ ] Verify: [how to check it worked]

    #### Phase 2: Implementation

    • [ ] Step 2.1: [action] in file.ts
    • [ ] Verify: [how to check]

    #### Phase 3: Tests

    • [ ] Step 3.1: Update tests in file.test.ts
    • [ ] Verify: Run npm test

    #### Phase 4: Cleanup

    • [ ] Remove deprecated code
    • [ ] Update documentation

    Rollback Plan

    If something fails:

  • [Step to undo]
  • [Step to undo]
  • Risks

    • [Potential issue and mitigation]

    Shall I proceed with Phase 1?

    Details

    Tools
    codebaseterminalCommand
    Filecopilot-contribution/prompts/refactor-plan.prompt.md

    How to Use

    In Copilot

    Add this .prompt.md file to your .github/prompts/ directory and invoke it from Copilot Chat.