Skip to content

Code-Style

  • Fachbegriffe auf Deutsch: Module, Entities und DTOs nutzen deutsche Domänenbegriffe — beitrag, betreuungsvertraege, elternportal, tagespflege, fremdgemeinde, sachkostenzuschuss, vermittlung, zuschuss usw.
  • Technische Begriffe auf Englisch: auth, tenant, user, mail, support und alle technischen Konstrukte bleiben englisch.
  • Code-Kommentare auf Englisch.

Jede Source-Datei beginnt mit dem Property-Header:

// Property of Ralf Carsjens - created in order to fulfill ISO 27001

Ausnahmen: Standard-JSON-Dateien, generierte Dateien und Lockfiles.

  • strict: true ist verbindlich.
  • Kein any ohne Begründung — stattdessen unknown plus Type-Guard.
  • Kein @ts-ignore — bei Bedarf @ts-expect-error mit Begründung.
  • consistent-type-imports ist aktiviert.
  • Struktur vor Schnelligkeit: modularer, gut kommentierter Code statt Quick-and-Dirty-Lösungen.
  • Kompakt schreiben: doppelte Branches zusammenführen, unnötige Verschachtelung vermeiden, gemeinsame Abstraktionen nutzen.
  • Bestehende Konventionen beachten: vor dem Schreiben neuer Komponenten zunächst prüfen, wie vergleichbare Komponenten im Codebase aufgebaut sind.