Diese Fähigkeit wird aufgerufen, wenn der Benutzer einen Refaktorierungsantrag erstellen möchte. Führen Sie die folgenden Schritte aus. Sie können Schritte überspringen, wenn Sie sie nicht für notwendig erachten.
-
Fragen Sie den Benutzer nach einer langen, detaillierten Beschreibung des Problems, das er lösen möchte, sowie nach möglichen Lösungsideen.
-
Erkunden Sie das Repository, um deren Behauptungen zu überprüfen und den aktuellen Zustand der Codebasis zu verstehen.
-
Fragen Sie, ob sie andere Optionen in Betracht gezogen haben, und präsentieren Sie ihnen andere Optionen.
-
Führen Sie ein Interview mit dem Benutzer über die Implementierung. Seien Sie äußerst detailliert und gründlich.
-
Arbeiten Sie den genauen Umfang der Implementierung aus. Legen Sie fest, was Sie ändern und was Sie nicht ändern möchten.
-
Überprüfen Sie die Codebasis auf Testabdeckung in diesem Bereich. Wenn die Testabdeckung unzureichend ist, fragen Sie den Benutzer nach seinen Plänen für Tests.
-
Teilen Sie die Implementierung in einen Plan aus winzigen Commits auf. Denken Sie an Martin Fowlers Ratschlag: "Machen Sie jeden Refaktorierungsschritt so klein wie möglich, damit Sie das Programm immer funktionieren sehen."
-
Erstellen Sie ein GitHub-Issue mit dem Refaktorierungsplan. Verwenden Sie die folgende Vorlage für die Issue-Beschreibung:
Problemstellung
Das Problem, mit dem der Entwickler konfrontiert ist, aus der Perspektive des Entwicklers.
Lösung
Die Lösung des Problems aus der Perspektive des Entwicklers.
Commits
Ein LANGER, detaillierter Implementierungsplan. Schreiben Sie den Plan in einfachem Englisch und unterteilen Sie die Implementierung in die kleinstmöglichen Commits. Jeder Commit sollte die Codebasis in einem funktionsfähigen Zustand hinterlassen.
Entscheidungsdokument
Eine Liste der getroffenen Implementierungsentscheidungen. Dies kann Folgendes umfassen:
- Die Module, die erstellt/geändert werden
- Die Schnittstellen dieser Module, die geändert werden
- Technische Klarstellungen des Entwicklers
- Architekturentscheidungen
- Schemaänderungen
- API-Verträge
- Spezifische Interaktionen
Fügen Sie KEINE spezifischen Dateipfade oder Codeausschnitte hinzu. Diese könnten sehr schnell veraltet sein.
Testentscheidungen
Eine Liste der getroffenen Testentscheidungen. Enthalten Sie:
- Eine Beschreibung, was einen guten Test ausmacht (nur externes Verhalten testen, keine Implementierungsdetails)
- Welche Module getestet werden
- Vorherige Beispiele für die Tests (d.h. ähnliche Testtypen in der Codebasis)
Außerhalb des Umfangs
Eine Beschreibung der Dinge, die für diese Refaktorierung außerhalb des Umfangs liegen.
Weitere Anmerkungen (optional)
Alle weiteren Anmerkungen zur Refaktorierung.