SuperAPI AI 工具集

request-refactor-plan

编程与开发

查看项目

更新于 10-16 05:44

技能介绍

用途:当用户想要创建重构请求时调用该技能,帮助把重构需求整理成可执行的计划并归档为 GitHub issue。

主要能力与流程:先让用户详细描述要解决的问题及可能的解决思路;探索代码库以验证用户说法并了解现状;询问用户是否考虑过其他方案并给出备选;就实现细节进行极其详尽的访谈;确定实现的确切范围,明确要改什么、不改什么;检查该代码区域的测试覆盖情况,若覆盖不足则询问用户的测试计划;把实现拆解为一系列微小提交,遵循 Martin Fowler 的建议,让每一步尽可能小,使程序始终处于可运行状态;最后用指定模板创建 GitHub issue。

issue 模板包含:问题陈述(从开发者视角描述所面临的问题)、解决方案(从开发者视角描述解决方式)、提交(用平实英文写出的长而详细的实现计划,拆成尽可能小的提交,每个提交都应让代码库保持可工作状态)、决策文档(列出实现决策,可包括将构建或修改的模块、将修改的模块接口、开发者的技术澄清、架构决策、模式变更、API 契约、具体交互;不要包含具体文件路径或代码片段,因为它们可能很快过时)、测试决策(好测试的标准,即只测试外部行为而非实现细节、将测试哪些模块、测试的先例即代码库中类似测试)、范围之外(描述本次重构不涉及的内容)、进一步说明(可选)。

使用方式:由用户触发该技能后按上述步骤逐步进行,可按需跳过不必要的步骤。

限制:资料未提供具体安装命令、收费方式、支持平台或效果保证等信息。