Sinnvolle Git commits

Über die richtige Formulierung von Git commits kann man sich streiten.

Folgende Artikel behandeln das Thema „sinnvolle Git commits“

Atomic commits with git und

How to Write a Git Commit Message

Letztendlich muss man sich innerhalb eines Teams darauf einigen, wie im Team damit umgegangen wird.

Oben genannte Artikel bringen das Thema sehr gut auf den Punkt:

  • Commits sollen aussagekräftig beschreiben, was passiert wenn man diese Änderung auf das Projekt anwendet.
  • Commits sollen so klein wie möglich gehalten werden.

Kleinstmögliche Commits sind vor allem in der Template-Entwicklung von Magento sehr sinnvoll. In vergangenen Projekten wurde ich mit dem Problem konfrontiert, dass phtml-Templates kopiert, in den entsprechenden Ordner verschoben und dort bearbeitet wurden – und erst danach wurde zum ersten mal commited. Anschließend kann man nur sehen, dass ein neues Template-File angelegt wurde. Die konkreten Änderungen zum Original, und von welchem Original kopiert wurde, lässt sich nicht auf einen Blick feststellen.

Der bessere Workflow wäre:

  • Kopie des ursprünglichen Templates + Commit „add copied file from …“
  • Ändern der Template-Datei + Commit „change behavior of …“

Kommentare

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert