agentleFS
wachawowachawo/claude-skills/skills/refactor/SKILL.md

refactor

Skill0 starsChanged 6 months agoMITView on GitHub

Produces a detailed refactoring plan with tiny commits via a user interview, captured as a GitHub issue. Use when the user wants to plan a refactor,

We split this skill into the rules it gives an agent

5 rules. 0 are common, 5 are distinctive, and 0 are very specific to this project.

  • 0

    Common

    Most of the 161 edited versions we read keep these.

  • 5

    Distinctive

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Ask the user for a long, detailed description of the problem they want to solve and any possible ideas for a solution.

    line 9
  2. Distinctive:

    Ask whether they have considered alternatives, and propose other options.

    line 13
  3. Distinctive:

    Look into the codebase to assess the test coverage of the area.

    line 19
  4. Distinctive:

    Create a GitHub issue with the refactoring plan.

    line 23
  5. Distinctive:

    Do NOT include concrete file paths or code snippets.

    line 51

“Common” is measured: kept by at least 6 in 10 of the 161 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

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.

  1. Ask the user for a long, detailed description of the problem they want to solve and any possible ideas for a solution.
  2. Explore the repository to verify their claims and to understand the current state of the codebase.
  3. Ask whether they have considered alternatives, and propose other options.
  4. Interview the user about the implementation. Be extremely detailed and thorough.
  5. Clearly capture the exact scope of the implementation. Specify what you plan to change and what you will not.
  6. Look into the codebase to assess the test coverage of the area. If coverage is insufficient, ask the user about their testing plans.
  7. 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."
  8. Create a GitHub issue with the refactoring plan. Use the following template for the issue body:
<refactor>

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.

</refactor>

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.