Zum Hauptinhalt springen

Coding Standards

In Bearbeitung

Diese Dokumentation wird derzeit erstellt.

Übersicht​

Coding-Standards und Best Practices für die School-SaaS Entwicklung.

Code-Style​

TypeScript​

  • Strikte TypeScript-Konfiguration
  • Keine any Types
  • Explizite Return-Types bei Funktionen

Naming Conventions​

  • camelCase für Variablen und Funktionen
  • PascalCase für Komponenten und Types
  • UPPER_SNAKE_CASE für Konstanten

Komponenten​

  • Funktionale Komponenten mit Hooks
  • Props-Interface für TypeScript
  • Default Exports für Pages, named Exports für Utilities

Code-Formatierung​

Wir verwenden:

  • Prettier für Code-Formatierung (Konfiguration: webapp/.prettierrc.yaml, Dependency prettier ^3.8.1). Einstellungen u. a.: arrowParens: always, singleQuote: true, tabWidth: 4, trailingComma: none.

Noch nicht eingerichtet: Ein ESLint-Setup (kein lint-Script, keine ESLint-Konfiguration) und Pre-Commit-Hooks (kein Husky) existieren aktuell nicht. Qualitätssicherung erfolgt über pnpm typecheck, die Tests und den Build (siehe CI in .github/workflows/ci.yml).