refactor-plan

Generate a refactoring plan with commit and testing strategies as a GitHub issue.

2|Updated Aug 8, 2024
One-click install
npx skills add https://github.com/walid-mos/mac-config --skill refactor-plan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: refactor-plan
Source: https://github.com/walid-mos/mac-config/tree/main/claude/.claude/skills/refactor-plan
Command: npx skills add https://github.com/walid-mos/mac-config --skill refactor-plan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps users meticulously plan and document complex code refactoring efforts, ensuring a structured approach and clear communication.

Core Features & Use Cases

  • Structured Planning: Guides users through a deep interview to define refactoring scope, risks, and implementation details.
  • Commit Strategy: Generates a granular commit plan, breaking down the refactor into small, manageable, and safe steps.
  • Testing Strategy: Assesses current test coverage and recommends a testing approach to safeguard the refactoring process.
  • Use Case: Planning a major architectural change to a core service, ensuring all affected modules, interfaces, and potential risks are identified and documented before any code is changed.

Quick Start

Initiate a refactoring plan for the user authentication module.

Frequently Asked Questions about refactor-plan

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I plan a complex code refactoring project before writing any code?

To plan complex code refactoring, you can use a structured approach that guides you through a deep interview to define problem statements, assess risks, and establish scope. This generates a detailed commit plan and testing strategy for safe implementation.

What is the best way to break down a large software refactor into safe commits?

The best way to break down a software refactor into safe commits is by generating a granular commit plan. This approach ensures the refactoring process is divided into small, manageable steps, safeguarded by a dedicated testing strategy.

How do I create a testing strategy for a major architectural change?

You create a testing strategy for an architectural change by assessing current test coverage and recommending a testing approach. This safeguards the refactoring process by identifying risks and documenting implementation details before code changes.

Can I output my refactoring plan directly as a GitHub issue?

Yes, you can output your refactoring plan directly as a GitHub issue. The planning process produces a decision document and a comprehensive commit plan that are formatted for GitHub issues to ensure clear communication.

Does this refactoring planning approach work for core service module changes?

Yes, this refactoring planning approach works for core service module changes. It is designed for complex scenarios, ensuring all affected modules, interfaces, and potential risks are meticulously identified and documented before code is changed.