Zufriedene Kunden

Tipps

Sind die grundlegenden Funktionen verstanden, machen oft die einfachen, vermeintlich kleinen Dinge einen spürbaren Unterschied und bringen einen Geschwindigkeitsvorteil in der täglichen Arbeit.

Git Kommentare

Jeder Commit sollte einen aussagekräftigen Kommentar erthalten. Dieser kann gerne kurz, sollte aber prägnant sein. Dabei gehört für mich IMMER eine Ticketnummer dazu, gefolgt von einer Beschreibung was getan wurde. Das sollte nicht nur der Titel des Tickets sein. Sonst erhält man in der History recht schnell dutzende Einträge mit exakt demselben Kommentar.

Ein Beispiel für einen gut gewählten Kommentar wäre:

CMS-854 added quicksave funtionality in edit mode

Benennung von Branches

Bei der Benennung von Branches gilt ähnliches wie für die Kommentare:

Es sollte eine Ticketnummer vorhanden sein (am besten als Prefix), und eine Beschreibung in wenigen Worten. Letzeres wird häufig nicht gemacht, aber im Projektalltag erhält man schnell eine Liste die ungefähr so aussieht:

  • git branch
    develop
    feature/CMS-1230
    feature/CMS-1230
    feature/CMS-1253
    feature/CMS-1284
    feature/CMS-1303
    feature/CMS-1415
    feature/CMS-1501
    feature/CMS-1531
    hotfix/CMS-1572
    hotfix/CMS-1710
    master

Die Anzahl an Branches ist schon recht aufgeräumt und trotzdem fällt es mir schwer zu jeder Ticketnummer wenigstens das Thema zu wissen. Für die 1,2 oder 3 Branches mit denen aktuell viel gearbeitet wird klappt das meist ganz gut, aber der Rest bleibt eben einfach ein Nummer. Fügt man nur 1-2 Stichworte hinzu, kann man meist sehr schnell das Ticket-Thema zuordnen:

  • feature/CMS-1230.etracker-video-tracking

Damit kann ich schon mehr anfangen. Und zur gleichen Zeit gibt es selten mehrere Branches mit demselben Thema. Damit kommen wir direkt zum nächsten Tip 🙂

Branches löschen

Nach dem Merge sollte ein Branch gelöscht werden. Sonst erhält man schnell eine „unendlich“ lange Liste an Branches, in der man sich kaum mehr orientieren kann. Wird gitlab oder ein ähnliches Tool verwendet, kann man den Branch beim Merge automatisch löschen zu lassen:

An der Commandline funktioniert das natürlich auch:

  • Löschen des Remote Branches
    • git push REMOTE –delete BRANCH_NAME
  • Löschen eines lokalen Branches
    • git branch -D BRANCH_NAME
  • Also z.B.
    • git push origin –delete feature/CMS-1230.etracker-video-tracking
    • git branch -D feature/CMS-1230.etracker-video-tracking