request-refactor-plan

Generate incremental refactor plans as standardized GitHub issues.

88|9|Updated Jul 16, 2020
One-click install
npx skills add https://github.com/docs-plus/docs.plus --skill request-refactor-plan-docs-plus
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: request-refactor-plan
Source: https://github.com/docs-plus/docs.plus/tree/main/.agents/skills/request-refactor-plan
Command: npx skills add https://github.com/docs-plus/docs.plus --skill request-refactor-plan-docs-plus

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Unstructured refactoring efforts often lead to broken code, missed edge cases, and wasted developer time, as teams lack a clear, incremental plan for code changes. This skill solves that by guiding you through a structured interview to build a detailed, low-risk refactor plan.

Core Features & Use Cases

  • Structured Problem Validation: Verifies your refactor assertions by exploring the codebase and confirming the current state of the affected code.
  • Incremental Commit Planning: Breaks refactors into the smallest possible working steps to ensure the codebase remains functional at every stage of the process.
  • Standardized GitHub Issue Generation: Automatically formats your refactor plan into a consistent GitHub issue with all required sections for team review and tracking. Use case: For example, if you want to refactor a legacy payment processing module, this skill will help you document the exact scope, out-of-scope items, testing requirements, and step-by-step commit plan in a shareable GitHub issue for your team.

Quick Start

Use the request-refactor-plan skill to create a detailed refactor plan for the payment processing module and file it as a GitHub issue for your team.

Frequently Asked Questions about request-refactor-plan

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

FAQPage Schema
How do I create a safe incremental refactor plan for a GitHub issue?

To create a safe incremental refactor plan, you need a structured approach that breaks code changes into the smallest possible working steps. This ensures the codebase remains functional and produces a standardized GitHub issue with problem statements, solution details, and testing guidelines for team review.

What is a refactoring RFC and how does it prevent broken code?

A refactoring RFC is a decision document that validates refactor assertions by exploring the codebase before making changes. It prevents broken code and missed edge cases by defining exact scope, out-of-scope items, and tiny commit plans, eliminating unstructured, high-risk refactoring efforts.

Can I use this structured refactor planning for legacy module migration?

Yes, structured refactor planning applies directly to legacy module migration. It guides you through a structured interview to document the exact scope, testing requirements, and step-by-step commit plan, generating a shareable GitHub issue for your team to review and track the migration safely.

How do I break large code refactoring work into reviewable steps?

You break large code refactoring work into reviewable steps by generating a detailed plan that emphasizes incremental commits. This process produces standardized GitHub issues containing tiny commit plans and decision documents, ensuring each step is safe, functional, and easily reviewable by your team.

Does this refactor planning approach validate existing codebase states?

Yes, this refactor planning approach validates existing codebase states. It features structured problem validation that explores the codebase to confirm the current state of the affected code, ensuring your refactor assertions are accurate before generating the incremental commit plan.