From 2d9643af9d51b425e683353f0d9b639713d8fdd8 Mon Sep 17 00:00:00 2001 From: Sebastian Frank Date: Wed, 15 Nov 2023 09:50:52 +0100 Subject: [PATCH] Coding Guideline aktualisiert --- Coding-Guideline.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/Coding-Guideline.md b/Coding-Guideline.md index b63c88a..d10e081 100644 --- a/Coding-Guideline.md +++ b/Coding-Guideline.md @@ -70,4 +70,25 @@ - jede Kollektion hat eigene Datei - Auslagern von größeren Datenstrukturen in eigene Dateien zur Wahrung der Übersicht - Auslagern von Feld-Konfigurationen, wenn diese kollektionsübergreifend mehrfach verwendet werden -- Verwendung \ No newline at end of file +- Verwendung von aussagekräftigen Feldnamen + - möglichst englische Namen + - camelCase Schreibweise +- benutzerfreundliche Label in deutsch und optional englisch +- falls nötig eine kurze Beschreibung für die UI, was bei diesem Feld wichtig ist oder wie es funktioniert, bzw. wo es Verwendung findet, wenn dies nicht automatisch klar seien sollte +- Verwendung des Validators + - Pflichtfelder kennzeichnen + - Inhalt validieren um keine bösen Überaschungen auf der Website zu erleben (JS-Fehler, weil undefined) + +``` +!!! Weniger ist mehr. Komplexe Strukturen so einfach wie möglich dem Benutzer aufbereiten !!! +``` + +- Inhalte, die so gut wie nie angepasst werden, müssen nicht ins Backend, z.B. + - Designelemente wie Logo, Farben +- Template-Bestandteile, die den Redakteur nix angehen, gehören auch nicht ins Backend, z.B. + - CSS, JS +- einmalig vorkommende Elemente können als Module zur Verfügung gestellt werden, müssen aber keine weiteren Daten im Backend haben, d.h. + - ein Eintrag in der Modul-Kollektion, aber keine weiteren Einstellungen + - können vom Redakteur in Inhalten zugeordnet werden + - binden im Frontend nur einen statischen Code-Block ein, z.B. + - komplexe Grafik/Animation, welche im Frontend eine Programmierung benötigt