request-refactor-plan

Create a detailed refactor plan with tiny commits and file it as a GitHub issue.

1|Updated Aug 16, 2023
One-click install
npx skills add https://github.com/monlor/dotfiles --skill request-refactor-plan-monlor
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: request-refactor-plan
Source: https://github.com/monlor/dotfiles/tree/main/config/ai/agents/skills/request-refactor-plan
Command: npx skills add https://github.com/monlor/dotfiles --skill request-refactor-plan-monlor

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill addresses the need for a structured refactor plan creation process, ensuring that refactor requests are detailed, actionable, and effectively documented as GitHub issues.

Core Features & Use Cases

  • User Interview: Facilitates a comprehensive understanding of the user's refactor needs and potential solutions.
  • Codebase Analysis: Validates the user's assertions and provides insights into the current state of the codebase.
  • Incremental Planning: Breaks down refactor plans into tiny commits for safe and manageable implementation.
  • GitHub Issue Creation: Files the refactor plan as a GitHub issue with a standardized template for easy tracking and collaboration.

Quick Start

To initiate a refactor plan, simply request the creation of a refactor plan via the AI interface.

Frequently Asked Questions about request-refactor-plan

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

FAQPage Schema
How does codebase analysis validate my software refactoring needs?

Codebase analysis validates your refactoring needs by examining the current state of the code. This process checks your assertions from the interview and provides insights to ensure the refactor plan is accurate and actionable.

What is the best way to break down a large codebase refactor into safe steps?

Breaking down a codebase refactor into safe steps is achieved through incremental planning. The Skill analyzes your codebase and user requirements to divide the refactor into tiny, manageable commits, ensuring safe implementation.

Can I use this to generate an RFC for software refactoring?

Yes, you can use this for RFC creation. The Skill is explicitly applicable for creating Requests for Comments by detailing the refactor plan and documenting the necessary steps and codebase insights.

Does the refactor planning process require a user interview?

Yes, a user interview is required. The Skill facilitates a comprehensive interview to understand your refactor needs and potential solutions before validating assertions and analyzing the codebase.

How does codebase analysis validate my software refactoring needs?

Codebase analysis validates your refactoring needs by examining the current state of the code. This process checks your assertions from the interview and provides insights to ensure the refactor plan is accurate and actionable.