agentleFS
SWEStashSWEStash/swe-workflow-skills/skills/refactoring/SKILL.md

refactoring

Skill1 starsChanged 5 days agoMITView on GitHub

Systematic code improvement via design principles, smell detection, and safe transformation patterns. Triggers: refactor this, clean this up, simplify this code, reduce complexity, extract this, this code is messy, tech debt, improve this code, code smell, rename, extract function, dead code.

58 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use ci-cd, multi-agent-orchestration and 8 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • JohnJBorenSkill

    ci-cd

    CI/CD pipeline design, GitHub Actions, testing automation, and deployment strategies

    Also in 5 projects that use this

  • javalenciacaiSkill

    multi-agent-orchestration

    Design and coordinate multi-agent systems where specialized agents work together to solve complex problems. Covers agent communication, task delegation, workflow orchestration, and result aggregation. Use when building coordinated agent teams, complex workflows, or systems requiring specialized expertise across domains.

    Also in 3 projects that use this

  • harrissohail6Skill

    database-design

    Database schema design and SQL best practices. Use when designing tables, writing queries, or optimizing database performance.

    Also in 5 projects that use this

  • MicrosoftSkill

    error-handling

    统一错误处理系统。在添加 API 端点、修改错误处理、添加前端 API 调用、编写错误相关测试时使用。

    Also in 7 projects that use this

  • klauswgSkill

    performance

    Optimize web performance for faster loading and better user experience. Use when asked to "speed up my site", "optimize performance", "reduce load time", "fix slow loading", "improve page speed", or "performance audit".

    Also in 7 projects that use this

  • AWSSkill

    planning

    Discovers user intent and generates a structured, step-by-step plan for model customization workflows. This skill must always be activated alongside any other skill when the user's request relates to model customization — including fine-tuning, training, building, customizing, reviewing data, or getting advice on approach, regardless of domain. Do not skip this skill even if the immediate ask is narrow (e.g., reviewing data format or a single workflow step), because planning discovers the full scope of work needed. Also activate when the user wants to resume, continue, or modify an existing plan.

    Also in 6 projects that use this

The file

Show its rules and text

We split this skill into the rules it gives an agent

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

  • 0

    Common

    Most of the 53 edited versions we read keep these.

  • 15

    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:

    Before refactoring anything, verify that tests exist for the behavior you're about to restructure.

    line 18
  2. Distinctive:

    Write characterization tests that document current behavior (even if the behavior has quirks)

    line 20
  3. Distinctive:

    Run them and confirm they pass

    line 21
  4. Distinctive:

    Only then begin refactoring

    line 22
  5. Distinctive:

    If the user resists writing tests first, explain: refactoring without tests is not refactoring, it's rewriting with hope.

    line 24
  6. Distinctive:

    Read the code and identify code smells.

    line 28
  7. Distinctive:

    If tests break, undo immediately.

    line 64
  8. Distinctive:

    After completing the planned sequence:

    line 68
  9. Distinctive:

    Run the full test suite

    line 71
  10. Distinctive:

    Check that no public API changed (unless that was the goal)

    line 72
  11. Distinctive:

    Look for any new smells introduced by the refactoring

    line 73
  12. Distinctive:

    KISS: Every transformation should make the code simpler, not more abstract

    line 78
  13. Distinctive:

    YAGNI: Don't introduce abstractions for hypothetical future needs during refactoring

    line 80
  14. Distinctive:

    Boy Scout Rule: Leave the code cleaner than you found it — every refactoring session should improve the surrounding code slightly, not just …

    line 82
  15. Distinctive:

    Kent Beck's 4 Rules of Simple Design: After refactoring, the code should: (1) keep all tests green, (2) reveal intention clearly, (3) …

    line 83

“Common” is measured: kept by at least 6 in 10 of the 53 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

Refactoring

Guide safe, incremental code improvements that preserve behavior while enhancing design. Refactoring is disciplined — every change is small, tested, and reversible.

Core Rule

Never change behavior and structure in the same step. Either you're adding a feature (behavior change) or you're refactoring (structure change). Mixing them creates bugs that are hard to trace.

Workflow

Step 1: Ensure Test Coverage

Before refactoring anything, verify that tests exist for the behavior you're about to restructure. If tests are missing:

  1. Write characterization tests that document current behavior (even if the behavior has quirks)
  2. Run them and confirm they pass
  3. Only then begin refactoring

If the user resists writing tests first, explain: refactoring without tests is not refactoring, it's rewriting with hope.

Step 2: Identify Smells

Read the code and identify code smells. Prioritize by impact — don't try to fix everything at once. The most common smells, roughly ordered by severity:

  1. Long function (>30 lines) → Extract method
  2. Duplicated logic → Extract and share
  3. Deep nesting (>3 levels) → Early returns, extract method
  4. Long parameter list (>4 params) → Introduce parameter object
  5. Feature envy → Move method to the class it uses most
  6. Primitive obsession → Introduce domain types
  7. Shotgun surgery → Consolidate related logic
  8. Divergent change → Split class by responsibility

See references/transformations.md for the complete catalog of safe transformations.

Step 3: Plan the Sequence

Order refactoring steps so that each step:

  • Is small enough to verify easily
  • Keeps all tests green
  • Makes the next step easier

A good sequence often looks like:

  1. Rename for clarity (cheapest, highest readability impact)
  2. Extract helpers to reduce function length
  3. Consolidate duplicates using the extracted helpers
  4. Move methods to better homes
  5. Simplify interfaces

Step 4: Execute — One Step at a Time

For each transformation:

  1. Explain what you're about to do and why
  2. Apply the single transformation
  3. Run tests and confirm green
  4. Show the diff to the user

If tests break, undo immediately. A failing test after refactoring means the transformation changed behavior — that's a bug, not a test to fix.

Step 5: Review the Result

After completing the planned sequence:

  • Compare before/after: Is the intent clearer? Is the code simpler?
  • Run the full test suite
  • Check that no public API changed (unless that was the goal)
  • Look for any new smells introduced by the refactoring

Principles Applied

  • DRY: Eliminate duplication discovered during refactoring
  • KISS: Every transformation should make the code simpler, not more abstract
  • SRP: Each extracted function/class should have one reason to change
  • YAGNI: Don't introduce abstractions for hypothetical future needs during refactoring
  • Functional Independence: Refactoring should reduce coupling, not increase it
  • Boy Scout Rule: Leave the code cleaner than you found it — every refactoring session should improve the surrounding code slightly, not just the target. Small cleanups (renaming, removing dead code) near the area you're working in compound over time.
  • Kent Beck's 4 Rules of Simple Design: After refactoring, the code should: (1) keep all tests green, (2) reveal intention clearly, (3) contain no duplication, (4) use the fewest classes and methods needed. Apply these as a checklist during Step 5 review.

Cross-Skill References

  • technical-debt-review — use to identify which areas are worth refactoring at a strategic level before starting
  • dependency-impact-analysis — use before refactoring a shared component or public interface to understand blast radius
  • code-slop-cleanup — most slop cleanup is a micro-refactor: use that skill for the pre-PR diff-scoped pass (removal-only, judged against file conventions); use this one when the cleanup turns structural (extract, move, re-abstract). They chain naturally: strip slop first, then refactor what remains

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.