SuperAPI AI 工具集

request-refactor-plan

编程与开发

查看项目

更新于 10-16 03:39

技能介绍

用途:当用户希望规划一次重构并创建重构请求时触发。技能会引导一次结构化的访谈,并最终产出一份 GitHub issue 形式的重构计划。

主要流程与能力:第一步,请用户尽可能详细地描述要解决的问题以及可能的解决思路。第二步,探索代码仓库,验证用户说法并了解代码库当前状态。第三步,询问用户是否考虑过其他方案,并向其呈现其他可选方案。第四步,围绕实现方案对用户进行极其细致、彻底的访谈。第五步,敲定实现的确切范围,明确计划改动与不改动的内容。第六步,在代码库中检查该区域的测试覆盖情况;若覆盖不足,询问用户的测试计划。第七步,把实现拆解为微小提交的计划,遵循 Martin Fowler 的建议,让每一步重构尽可能小,以便始终能看到程序正常运行。第八步,按模板创建 GitHub issue。

Issue 模板结构:Problem Statement(开发者视角的问题)、Solution(开发者视角的解决方案)、Commits(用平实英语撰写、尽可能细分的提交实现计划,每个提交都应让代码库保持可用状态)、Decision Document(实现决策清单,可含将构建或修改的模块、这些模块将被修改的接口、开发者的技术澄清、架构决策、schema 变更、API 契约、具体交互;不要包含具体文件路径或代码片段,因为它们可能很快过时)、Testing Decisions(测试决策清单,含好测试的描述:只测外部行为而非实现细节、将测试哪些模块、测试的既有先例)、Out of Scope(本次重构范围之外的内容)、Further Notes(可选,其他说明)。

限制与说明:技能允许在认为不必要时跳过某些步骤。原文未说明具体安装命令、依赖平台、收费方式或价格信息,这些内容暂未提供。