AGENT SKILL

request-refactor-plan

通过用户访谈创建由微小提交组成的详细重构计划,然后将其作为 GitHub 事项提交。当用户想规划重构、创建重构 RFC,或将重构拆分为安全的增量步骤时使用。

License 许可
MIT
最近更新
2026-07-23
Stars
★ 1
Forks
0

01 前言 Front Matter

name
request-refactor-plan
description
通过用户访谈创建由微小提交组成的详细重构计划,然后将其作为 GitHub 事项提交。当用户想规划重构、创建重构 RFC,或将重构拆分为安全的增量步骤时使用。

02 资源文件 1

03 SKILL.md 正文

当用户想创建重构请求时,会调用此技能。你应当完成以下步骤。如果认为某些步骤没有必要,可以跳过。

  1. 请用户详细说明想要解决的问题,并描述所有可能的解决思路。

  2. 探索仓库,验证用户的陈述并了解代码库当前状态。

  3. 询问用户是否考虑过其他选项,并向他们介绍其他选项。

  4. 围绕实现访谈用户。务必极其细致、全面。

  5. 反复推敲实现的确切范围。明确计划更改和计划不更改的内容。

  6. 检查代码库中该区域的测试覆盖率。如果测试覆盖不足,请询问用户的测试计划。

  7. 将实现拆分为由微小提交组成的计划。请牢记 Martin Fowler 的建议:“make each refactoring step as small as possible, so that you can always see the program working.”

  8. 创建包含重构计划的 GitHub 事项。事项描述使用以下模板:

<refactor-plan-template>

问题陈述

从开发者视角描述其面临的问题。

解决方案

从开发者视角描述问题的解决方案。

提交

一份详尽的长篇实现计划。使用通俗语言编写计划,将实现拆分为尽可能小的提交。每次提交后,代码库都应当保持可用状态。

决策文档

列出已经作出的实现决策。可以包括:

  • 将要构建或修改的模块
  • 将要修改的模块接口
  • 开发者提供的技术澄清
  • 架构决策
  • Schema 变更
  • API 契约
  • 具体交互

不得包含具体文件路径或代码片段。它们可能很快过时。

测试决策

列出已经作出的测试决策。包括:

  • 说明优秀测试的标准(只测试外部行为,不测试实现细节)
  • 将要测试哪些模块
  • 测试先例(即代码库中类似类型的测试)

超出范围

说明此次重构范围之外的内容。

补充说明(可选)

关于此次重构的任何补充说明。

</refactor-plan-template>

04 同仓库更多 Skills