request-refactor-plan

Interview users and verify repositories to create GitHub refactor issues.

12|Updated Dec 25, 2024

Search Tags:#testing strategy #architecture decisions #RFC #github issue #refactor planning #codebase scope #tiny commits

Ready to run

npx skills add https://github.com/whyte25/reusables --skill request-refactor-plan-whyte25

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: request-refactor-plan
Source: https://github.com/whyte25/reusables/tree/main/.agents/skills/request-refactor-plan
Command: npx skills add https://github.com/whyte25/reusables --skill request-refactor-plan-whyte25

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you turn a vague refactor idea into a concrete, low-risk plan by gathering detailed requirements, scoping changes precisely, validating test readiness, and producing a clear refactor issue you can execute with confidence.

Core Features & Use Cases

User interview to capture requirements: Collects an extremely detailed problem description, constraints, assumptions, and desired outcomes.
Repo-aware validation: Explores the codebase to verify assertions about the current state before proposing a plan.
Tiny-commit refactor breakdown: Converts the intended changes into the smallest safe incremental steps so the codebase remains working at every stage.
GitHub issue output: Creates a structured GitHub issue using a refactor-plan template including commits, decisions, testing, and out-of-scope items.

Quick Start

Tell the Skill what you want to refactor, why you need it, and the specific parts of the codebase involved.

Frequently Asked Questions about request-refactor-plan

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

FAQPage Schema

How do I plan a codebase refactor with tiny incremental commits?▼

A tiny-commit refactor breakdown decomposes large changes into the smallest safe incremental steps, ensuring the codebase remains working at every stage to reduce risk and confusion during execution.

How do I write a refactoring RFC for a large codebase change?▼

Writing a refactoring RFC involves gathering detailed problem descriptions and constraints, verifying codebase assertions, enumerating implementation decisions, and producing a structured GitHub issue with testing approaches and out-of-scope items.

Do I need comprehensive test coverage before starting a refactor plan?▼

Assessing test coverage is a required step in refactor planning. The process validates test readiness and confirms the current repository state before proposing any safe step-by-step implementation work.

What's the best way to scope a large codebase refactor safely?▼

Scoping a large refactor safely requires a thorough user interview to capture constraints and desired outcomes, followed by repo-aware validation to verify assertions about the current codebase state before proposing changes.

How to create a GitHub issue for an architecture decision and refactor plan?▼

Creating a GitHub issue for a refactor plan uses a structured template that includes tiny incremental commits, architecture decisions, testing approaches, and explicitly defined out-of-scope items to guide execution.