Skip to content

Code Styling & Best Practices Guide

1. Allgemeine Regeln

  • Sprache: Alle Variablen, Funktionen, Klassen, Kommentare und Commits sind strikt in Englisch.
  • Clean Code: DRY (Don't Repeat Yourself) und SOLID-Prinzipien anwenden.
  • Sicherheit: Zero-Trust Ansatz. Jeder API-Call muss Token und RBAC-Rolle prüfen.

2. Rust Spezifika (Backend & Agent)

  • Error Handling (Kein Try/Catch): Rust nutzt Result<T, E>.
    • Nutze den ? Operator zur Fehler-Propagierung.
    • Verwende NIEMALS .unwrap() oder .expect() in Produktionscode.
    • Implementiere einen globalen AppError (der IntoResponse für Axum implementiert).
  • Logging: Nutze das tracing Crate (info!, warn!, error!). Vermeide println!.
  • Asynchronität: Blockiere niemals den Tokio-Thread. Rechenintensive Aufgaben in tokio::task::spawn_blocking auslagern.

3. Vue.js Spezifika (Frontend)

  • API-Stil: Ausschließlich Composition API (<script setup>).
  • Error Handling: Hier ist try { ... } catch (e) { ... } bei Axios/Fetch-Aufrufen Pflicht.
  • Feedback: Bei jedem Fehler muss der User visuelles Feedback (z. B. Toast-Notification) erhalten.
  • Reaktivität: Nutze ref() für primitive Datentypen und reactive() für komplexe Objekte.

Released under the MIT License.