Developer Guidelines Konventionen

Konventionen

Hier sind die Definition of Done und einige Code Konventionen festgehalten.

Definition of Done

1. Die angegebenen Anforderungen an die Funktionalität sind erreicht.
2. Der Code ist ausreichend dokumentiert.
3. Clean Code Kriterien sind eingehalten.
4. Falls eine kritische Funktion für die Anwendung implementiert wird, muss diese ebenfalls ausreichend durch Unit Tests abgedeckt sein.

Code Konventionen

Nachfolgend werden die wichtigsten Code Conventions aufgelistet, auf die wir uns im Team geeinigt haben. Diese folgen größtenteils dem Google Typescript Styleguide.

Commit Konventionen

Die Commit-Messages müssen den commit Konventionen folgen. Dies wird automatisch von Commitlint geprüft und bei Fehlern blockiert.

Benennung von Variablen, Konstanten und Weiterem

Variablen und Funktionen werden in camelCase geschrieben. Dabei unterscheiden wir noch zwischen wirklichen Konstanten, die einmal definiert und nicht mehr geändert werden. Diese werden in UPPER_CASE definiert. Hierbei kann es etwas zu Verwirrung kommen, da in Typescript Variablen mit let und const initialisiert werden können, ESLint jedoch const preferiert. Daher soll laut ESLint auch ein Array, dessen Elemente sich ändern dürfen, mit const initialisiert werden.

Klassen, Interfaces, Enums und Types werden in PascalCase geschrieben. Die Elemente von Enums werden ebenfalls in PascalCase geschrieben (abweichend vom Google Typescript Styleguide).

Formatierung

Die Formatierung des Codes wird von Prettier übernommen und bei jedem Commit automatisch ausgeführt.