Skip to content

Git Konventionen

Jump to bottom
Felix Auringer edited this page Aug 5, 2020 · 2 revisions

Git

Allgemein

  • Branches, die in den dev gemerged wurden werden gelöscht (sonst viel Müll im Git Browser von Squeak)

Branchname

Branchnamen sollten dem folgenden Schema folgen: <type>/<issue-number>-<short-description>, z.B. feature/03-blank-line-method-title. Der type ist entweder feature, refactoring oder bugfix. Falls die Issuenummer kleiner 10 ist, wird eine 0 vorangestellt. Das Thema der geplanten Änderung sollte in wenig Worten (2 bis 4) zusammengefasst werden, wobei die Worte mit - getrennt werden und klein geschrieben werden. Branchnamen werden in Englisch verfasst.

Commit Message

Eine Commit Message sollte niemals beschreiben, wie etwas implementiert wurde (git diff ist dafür völlig ausreichend), sondern sollte sich darauf fokussieren, was die Änderung ist und warum diese eingeführt wird. Eine Commit Message besteht aus zwei Teilen: Subject und Body. Commit Messages werden in Englisch verfasst.

Subject

  • das Subject sollte immer folgenden Satz vervollständigen ('Imperative Mood'): If applied, this commit will subject
  • maximal 50 Zeichen lang
  • startet mit einem Großbuchstaben
  • kein Punkt am Ende des Subjects
  • fasst die Änderung kurz zusammen

Body

  • optional
  • durch eine Leerzeile abgetrennt
  • nach 72 Zeichen einen Zeilen umbruch -> rechteckige Form

Für weitere Informationen und Beispiele ist dieser Blogpost empfehlenswert.

GitHub

Issues / PRs

  • Titel startet mit Großbuchstaben
  • Titel enthält Beschreibung des Themas mit wenigen Worten (ähnlich zum Branchnamen, aber auch ein paar Worte mehr möglich)
  • Label für user story / bug / refactoring hinzufügen
  • sowohl Titel als auch Body in Deutsch

Body von PRs

  • durch closes #<issue> das entsprechende Issue referenzieren
  • falls nötig kurze Beschreibung, warum diese Änderung vollzogen werden sollte (der Verweis auf das Issue sollte in den meisten Fällen reichen)

Body von Issues

  • user story: Inhalt der entsprechenden Karte aus dem User-Story-Board
  • bug: kurze Beschreibung was der Fehler ist UND wie man ihn reproduzieren kann
  • refactoring: kurze Beschreibung, welcher Code überarbeitet werden soll und warum dies erforderlich ist
Clone this wiki locally