This skill is invoked when the user wants to create a refactoring request. Walk through the steps below. Some steps may be skipped if you consider them unnecessary.
Ask the user for a long, detailed description of the problem they want to solve and any possible ideas for a solution.
Explore the repository to verify their claims and to understand the current state of the codebase.
Ask whether they have considered alternatives, and propose other options.
Interview the user about the implementation. Be extremely detailed and thorough.
Clearly capture the exact scope of the implementation. Specify what you plan to change and what you will not.
Look into the codebase to assess the test coverage of the area. If coverage is insufficient, ask the user about their testing plans.
Break the implementation into a plan of tiny commits. Recall Martin Fowler's advice: "make each refactoring step as small as possible, so that you can always see the program working."
Create a GitHub issue with the refactoring plan. Use the following template for the issue body:
Problem Statement
The problem the developer faces, from the developer's perspective.
Solution
The solution to the problem from the developer's perspective.
Commits
A LONG, detailed implementation plan. Write the plan in plain English, breaking the implementation into the tiniest possible commits. Each commit must leave the codebase in a working state.
Decision Document
A list of accepted implementation decisions. This may include:
- Modules that will be built/modified
- Interfaces of those modules that will be changed
- Technical clarifications from the developer
- Architectural decisions
- Schema changes
- API contracts
- Specific interactions
Do NOT include concrete file paths or code snippets. They can become stale very quickly.
Testing Decisions
A list of accepted testing decisions. Include:
- A description of what makes a good test (test only external behavior, not implementation details)
- Which modules will be tested
- Precedents for the tests (i.e., similar kinds of tests in the codebase)
Out of Scope
A description of what is outside the scope of this refactor.
Further Notes (optional)
Any additional notes about the refactor.