Changelog der (Breaking) Changes auf dem uuid Branch
Aktuell werden große Änderungen auf dem feat-uuid
Zweig gemacht.
Damit man als Entwickler (anderer Pakete) später nachvollziehen kann, was sich alles geändert hat, sollte ein Changelog geführt werden.
Theoretisch passiert das automatisch basierend auf dem Commit Messages.
Allerdings sind die Commits riesig und unzureichend beschrieben, dass die automatisierte Changelog Generierung niemandem helfen wird.
Bspw. würde refactor: system test interfaces + removed deprecated stuff
(619739ef) nicht einmal im Changelog auftauchen.
Außerdem weiß niemand was der entfernte "stuff" jetzt ist.
Ich würde mir also wünschen, dass die Änderungen atomarer commitet werden.
Basierend auf dem Beispiel oben:
feat: add system test interfaces
feat!: remove deprecated "QUI\Interfaces\System\Patch" interface
feat!: remove deprecated "QUI\System\Checks" class
Beim Einspielen einzelner Änderungen hilft git commit -p
oder die PhpStorm Commit UI.
Siehe dazu auch mein ausführlicher Wiki Eintrag: https://dev.quiqqer.com/quiqqer/stabilization/documentation/-/wikis/Anleitung-f%C3%BCr-Entwickler#optimal-commiten-und-pushen
Sollte das, warum auch immer, nicht möglich sein, sollte zumindest irgendwo festgehalten werden, was sich jetzt alles geändert hat.
Ansonsten weiß hinterher niemand was jetzt alles potentiell kaputt gegangen ist und man muss jede einzelne Klasse nach Fehlern durchsuchen.
Die Dokumentation der Änderungen sollte nicht nur für jetzt noch kommende, sondern auch für bereits gemachte Änderungen geschehen.
Am besten wäre es, jetzt alle Änderungen noch einmal durchzugehen und kleinere Commits zu erstellen.