Labsco
github logo

refactor-plan

✓ Official36,200

by github · part of github/awesome-copilot

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

🔥🔥🔥✓ VerifiedFreeQuick setup
🧩 One of 7 skills in the github/awesome-copilot package — works on its own, and pairs well with its siblings.

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

Inspect the full instructions your agent will receiveExpand

This is the exact playbook injected into your agent when the skill activates — shown here so you can audit it before installing. You don't need to read it to use the skill.

by github

Plan a multi-file refactor with proper sequencing and rollback steps npx skills add https://github.com/github/awesome-copilot --skill refactor-plan Download ZIPGitHub36.2k

Refactor Plan

Create a detailed plan before making any code changes.

Instructions

  • Do not edit files while preparing the plan.

  • Search the codebase to understand the current state. Read enough implementation, tests, configuration, and docs to make the plan specific to the repository.

  • Identify affected files, ownership boundaries, dependencies, and likely hidden coupling.

  • Plan changes in a safe sequence. Prefer contracts and types first, then implementations, then callers, then tests, then cleanup.

  • Include verification steps between phases and a final validation command.

  • Include rollback or recovery steps for the riskiest phases.

  • Output the complete plan using the format below.

  • Stop after the plan and ask for confirmation before implementing. If the user already asked you to implement, still produce the plan first and wait for confirmation unless they explicitly said to continue without review after the plan.

If the request is too ambiguous to plan safely, ask concise clarifying questions instead of editing files.

Output Format

Copy & paste — that's it

## 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:
1. [Step to undo]
2. [Step to undo]

### Risks
- [Potential issue and mitigation]

After the plan, ask: "Shall I proceed with Phase 1?"