关于 request-refactor-plan
将重构请求整理为经过讨论的详细计划和 GitHub issue。它引导需求梳理、范围界定、测试决策及渐进式提交规划。
主要功能
- 01检查当前代码库
- 02讨论替代方案与实现细节
- 03明确范围和测试决策
- 04规划小步且可运行的提交
- 05创建结构化 GitHub issue
适用场景
- 01准备重构提案
- 02敲定重构范围和测试方案
- 03将改动拆分为渐进式提交
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/request-refactor-plan确认已加载。
附带文件agents/openai.yaml
详细介绍
当用户希望创建重构请求时，将调用此技能。你应按以下步骤操作。如果认为没有必要，可以跳过某些步骤。
-
请用户提供对所解决问题的详细描述，以及可能采用的解决方案。
-
检查仓库，以验证用户的说法并了解代码库的当前状态。
-
询问用户是否考虑过其他方案，并向他们介绍其他可选方案。
-
围绕实现细节访谈用户。务必详尽、彻底。
-
敲定实现的准确范围。明确计划更改的内容以及不计划更改的内容。
-
检查代码库中该领域的测试覆盖率。如果测试覆盖不足，请询问用户的测试计划。
-
将实现拆分为一系列微小提交的规划。谨记 Martin Fowler 的建议：“让每个重构步骤尽可能小，这样你始终都能看到程序正常运行。”
-
使用以下模板创建包含重构计划的 GitHub issue：
问题陈述
从开发者角度描述其面临的问题。
解决方案
从开发者角度描述问题的解决方案。
提交
一份详尽的实现计划。使用平实语言，将计划拆分为尽可能微小的提交。每次提交后，代码库都应保持可运行状态。
决策文档
已作出的实现决策列表。可以包括：
- 将要构建或修改的模块
- 将要修改的模块接口
- 来自开发者的技术说明
- 架构决策
- 模式变更
- API 契约
- 具体交互
不要包含具体文件路径或代码片段。它们可能很快就会过时。
测试决策
已作出的测试决策列表，包括：
- 什么是优质测试的说明（只测试外部行为，不测试实现细节）
- 将要测试的模块
- 测试的现有范例（即代码库中类似的测试）
范围之外
对本次重构范围之外事项的说明。
补充说明（可选）
关于本次重构的任何补充说明。
评论
支持 Markdown