SuperAPI AI 工具集

request-refactor-plan

编程与开发

查看项目

更新于 10-16 00:21

技能介绍

用途:当用户想要创建重构计划时调用该技能,帮助把重构需求整理成可执行的方案。

主要能力与流程:先让用户详细描述要解决的问题及可能的解决思路;探索代码库以核实其说法并了解现状;询问是否考虑过其他方案并给出备选;就实现细节进行极其详尽的访谈;敲定实现范围,明确要改什么、不改什么;检查该区域代码的测试覆盖,若不足则询问用户的测试计划;把实现拆解为尽可能小的提交计划,遵循 Martin Fowler 的建议“让每个重构步骤尽可能小,以便始终能看到程序正常运行”;最后创建 GitHub issue 记录重构计划。

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

使用方式:由用户提出重构计划需求时触发,按上述步骤逐步进行,可按需跳过不必要步骤。

限制:资料未提供具体安装命令、平台支持、收费或价格信息;也未提供实际代码示例。