当用户想要创建重构请求时,将调用此技能。请按以下步骤操作。如果你认为某些步骤不必要,可以跳过。
-
请用户提供关于他们想要解决的问题的详细描述,以及任何潜在的解决方案想法。
-
浏览仓库以验证用户的断言,并了解代码库的当前状态。
-
询问用户是否考虑过其他选项,并向他们展示其他选项。
-
与用户详细讨论实现方案。务必极其详细和全面。
-
确定确切的范围。明确计划变更的内容和不变更的内容。
-
在代码库中检查该区域的测试覆盖率。如果测试覆盖率不足,询问用户的测试计划。
-
将实现分解为一系列微小的提交。记住Martin Fowler的建议:“让每个重构步骤尽可能小,这样你就能始终看到程序在运行。”
-
创建一个包含重构计划的GitHub Issue。使用以下模板作为Issue描述:
问题陈述
从开发者角度描述所面临的问题。
解决方案
从开发者角度描述问题的解决方案。
提交计划
一份详细、冗长的实现计划。用简单明了的语言编写,将实现分解为尽可能小的提交。每个提交都应使代码库处于可工作状态。
决策文档
一系列已做出的实现决策。可以包括:
- 将要构建/修改的模块
- 这些模块将要修改的接口
- 开发者的技术说明
- 架构决策
- 模式变更
- API契约
- 具体交互
不要包含具体的文件路径或代码片段。它们可能很快就会过时。
测试决策
一系列已做出的测试决策。包括:
- 良好测试的描述(只测试外部行为,不测试实现细节)
- 将要测试的模块
- 测试的现有参考(即代码库中类似类型的测试)
不在此范围
此重构不涉及的范围描述。
进一步说明(可选)
关于重构的任何其他说明。