request-refactor-plan

Interview users to create stepwise refactor plans recorded as GitHub issues.

Updated Dec 11, 2024
One-click install
npx skills add https://github.com/huaxel/dotfiles --skill request-refactor-plan-huaxel
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: request-refactor-plan
Source: https://github.com/huaxel/dotfiles/tree/main/skills/request-refactor-plan
Command: npx skills add https://github.com/huaxel/dotfiles --skill request-refactor-plan-huaxel

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Current development teams often struggle to define and document cohesive refactor plans for RFC-based changes, leading to scope creep and ineffective commits.

Core Features & Use Cases

  • Interview-driven requirement gathering to clarify goals and constraints.
  • Stepwise plan generation with tiny commits mapped to a GitHub issue template.
  • Validation steps, including test coverage checks and scope decisions, with a clear hand-off to implementers.

Quick Start

Describe your refactor goal and the repository to begin.

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 stepwise refactor plan with tiny commits?

To create a stepwise refactor plan with tiny commits, this Skill conducts an interview to gather requirements and scope, then outputs a detailed plan mapped to a GitHub issue template. It defines commit-by-commit tasks and includes validation steps for test coverage.

What is the best way to document RFC-driven refactors for a development team?

Documenting RFC-driven refactors is best handled by an interview-driven requirement gathering process. This approach clarifies goals and constraints, preventing scope creep by recording the structured plan directly as a GitHub issue for clear hand-off to implementers.

How do I turn an interview into a structured GitHub issue for codebase refactoring?

You can turn an interview into a structured GitHub issue by describing your refactor goal and repository. The Skill interviews you to define scope and testing coverage, generating an issue-template-driven output with commit-by-commit tasks for implementation.

Does this interview-based planning approach check test coverage before finalizing a refactor scope?

Yes, this interview-based planning approach checks test coverage as part of its validation steps. It ensures scope decisions are validated against test coverage before generating the final commit-by-commit tasks in the GitHub issue.

Can I use this to plan refactors for any codebase or does it require a specific framework?

You can use this to plan refactors for any codebase undergoing RFC-driven changes. It does not require specific frameworks or dependencies, relying solely on an interview process to gather requirements and output a tiny-commit refactor plan.

Why should I use an interview to generate a refactor plan instead of writing it manually?

Using an interview to generate a refactor plan prevents scope creep and ineffective commits by enforcing structured requirement gathering. It clarifies constraints upfront and produces an issue-template-driven output with small-commit granularity for a clear implementation hand-off.