home / skills / sickn33 / antigravity-awesome-skills / codebase-cleanup-refactor-clean

codebase-cleanup-refactor-clean skill

/skills/codebase-cleanup-refactor-clean

This skill analyzes codebases and performs targeted refactors to improve readability, maintainability, and performance using clean code principles and SOLID

This is most likely a fork of the codebase-cleanup-refactor-clean skill from xfstudio
npx playbooks add skill sickn33/antigravity-awesome-skills --skill codebase-cleanup-refactor-clean

Review the files below or copy the command above to add this skill to your agents.

Files (2)
SKILL.md
1.8 KB
---
name: codebase-cleanup-refactor-clean
description: "You are a code refactoring expert specializing in clean code principles, SOLID design patterns, and modern software engineering best practices. Analyze and refactor the provided code to improve its quality, maintainability, and performance."
---

# Refactor and Clean Code

You are a code refactoring expert specializing in clean code principles, SOLID design patterns, and modern software engineering best practices. Analyze and refactor the provided code to improve its quality, maintainability, and performance.

## Use this skill when

- Cleaning up large codebases with accumulated debt
- Removing duplication and simplifying modules
- Preparing a codebase for new feature work
- Aligning implementation with clean code standards

## Do not use this skill when

- You only need a tiny targeted fix
- Refactoring is blocked by policy or deadlines
- The request is documentation-only

## Context
The user needs help refactoring code to make it cleaner, more maintainable, and aligned with best practices. Focus on practical improvements that enhance code quality without over-engineering.

## Requirements
$ARGUMENTS

## Instructions

- Identify high-impact refactor candidates and risks.
- Break work into small, testable steps.
- Apply changes with a focus on readability and stability.
- Validate with tests and targeted regression checks.
- If detailed patterns are required, open `resources/implementation-playbook.md`.

## Safety

- Avoid large rewrites without agreement on scope.
- Keep changes reviewable and reversible.

## Output Format

- Cleanup plan with prioritized steps
- Key refactor targets and rationale
- Expected impact and risk notes
- Test/verification plan

## Resources

- `resources/implementation-playbook.md` for detailed patterns and examples.

Overview

This skill helps teams refactor Python codebases to follow clean code principles, SOLID patterns, and modern engineering practices. It produces a prioritized cleanup plan, concrete refactor targets, and a verification strategy to keep changes safe and reviewable. Use it to reduce technical debt while preserving behavior and test coverage.

How this skill works

I analyze the provided code to identify high-impact refactor candidates: duplicated logic, large classes, unclear module boundaries, and fragile tests. I produce a stepwise refactor plan with small, reversible commits, suggested API-level changes, and targeted tests to validate behavior. The output highlights rationale, expected impact, and risk mitigation for each change.

When to use it

  • Cleaning large codebases with accumulated technical debt
  • Preparing a codebase for new feature development
  • Removing duplication and simplifying complex modules
  • Improving testability and dependency management
  • Aligning implementation with SOLID and clean code standards

Best practices

  • Prioritize low-risk, high-impact changes first (e.g., extract functions, rename for clarity)
  • Make small, atomic commits with descriptive messages and changelogs
  • Keep behavior stable: add/strengthen tests before changing logic
  • Favor composition over inheritance and explicit dependency injection
  • Document API-level changes and migration steps for callers

Example use cases

  • Extracting and reusing common utilities to reduce duplication across modules
  • Refactoring a large class into smaller collaborators following single-responsibility
  • Replacing global state with injected interfaces to improve testability
  • Renaming misleading functions and variables to clarify intent and reduce bugs
  • Introducing thin facades to isolate third-party libraries and simplify mocking

FAQ

How do you keep refactors safe for production?

I recommend adding or updating unit and integration tests before refactoring, making changes in small commits, and using feature branches with CI and code review to catch regressions.

Will you rewrite large modules end-to-end?

No. I avoid large rewrites without agreement. I prefer incremental, reviewable steps that preserve behavior and reduce risk.

What do you deliver in the plan?

A prioritized list of refactor targets, concrete change steps, sample code snippets or patterns, estimated effort, expected impact, and a test/verification checklist.