Skip to content

Git Konventionen

Korkmaz, Fahri edited this page Apr 19, 2021 · 1 revision

Git Konvention

Branches

Alle Branches sollten folgend benannt werden:

  • Master Branch: master
  • Development Branch: development
  • Issue Branch: <ISSUE-ID>-<ISSUE-TITEL>
  • User Branch: <Vorname>

Development

In den Development Branch dürfen nur Issue Branches oder User Branches gemerged werden.

Master Branch

Es ist nichts direkt in den Master Branch zu commiten. Es darf nur der Development Branch in den Master Branch gemerged werden. Außnahmen dazu sind Hotfixes. Der Code im Master Branch sollte immer lauffähig sein. Merges in den Master Branch werden nach einem gemeinsamen Code Review jeden Donnerstag ab 15:45 durchgeführt.

Hotfixes

Hotfixes sind Fehlern vorbehalten, welche so gravierend sind, dass diese schnell und gezielt behoben werden müssen. Hotfixes müssen als Commit Message Titel HOTFIX: <Beschreibung> haben.

Commit Messages

  • Commit Messages sollten in Englisch und im Past Tense verfasst werden
  • Ausnahmen sind Hotfixes. Mehr dazu bei Hotfixes.

Bei Merges muss die Commit Message den Standardtitel beinhalten, welcher von Gitlab verwendet wird.

Merge Requests

Titel

Der Titel der assoziierten Issue oder eine kurze Beschreibung, wenn keine Issue existiert.

Inhalt

Der Body sollte mindestens den Text "Closes #" beinhalten. Alle Tickets die durch diesen Merge Request geschlossen werden, sollten in dem Format erwähnt werden. Gerne kann eine Beschreibung des Merge Requests hinzugefügt werden.

Issues

Titel

Der Titel einer Issue soll eine sehr knappe Zusammenfassung des Inhalts sein und darf keine Sonderzeichen wie z.B. []()\/;+-* enthalten. Die einzige Ausnahme dazu ist :.

Inhalt

Der Inhalt sollte das Ziel des Issues beschreiben.