Code Reviews
⚠️ Dieser Prozess ist nicht final und kann sich jederzeit ändern oder weiterentwickeln.
Grundprinzipien
-
Code Reviews erfolgen pro Ticket, nicht gesammelt über mehrere Tickets hinweg
-
Reviews sollen schnell und effizient sein (typischerweise 3–10 Minuten)
-
Wenn Code deutlich länger braucht um verstanden zu werden, ist das ein Hinweis auf ein Problem
-
Ausnahmen gelten für komplexe oder kritische Logik (z. B. Algorithmen)
-
Ziele
Der Fokus liegt auf dem Gesamtbild, nicht auf Detailoptimierungen.
-
Architektur
-
Systemdesign
-
Verständlichkeit
-
Qualitätssicherung auf hoher Ebene
Ablauf
Vorbereitung
Vor dem Erstellen eines Commits:
-
Sicherstellen, dass der Code funktioniert
-
Relevante Tests ausführen
-
Änderungen klar und nachvollziehbar halten
-
Kurz beschreiben:
-
Was wurde geändert?
-
Warum wurde es geändert?
-
Review
Im Review wird vor allem geprüft:
-
Ist die Struktur des Codes verständlich?
-
Ist die Lösung im Gesamtsystem sinnvoll?
Diskussionen konzentrieren sich auf:
-
Sicherheit
-
Robustheit
-
Performance
-
Einfachheit
Ergebnis
Ein Review gilt als nicht bestanden, wenn:
-
der Code schwer verständlich ist
-
die Struktur unklar ist
-
Designentscheidungen nicht nachvollziehbar sind
In diesem Fall sind Vereinfachung oder bessere Struktur erforderlich.
Präventive Code Reviews
Bei Unsicherheiten bezüglich Ansatz oder Design sollte frühzeitig Feedback eingeholt werden, bevor mit der Implementierung begonnen wird.
Best Practices
Autoren
-
Code einfach und verständlich halten
-
Unnötige Komplexität vermeiden
-
Änderungen klar pro Ticket trennen
Reviewer
-
Fokus auf Architektur und Gesamtbild
-
Keine Detaildiskussionen ohne Mehrwert
-
Feedback klar und begründet formulieren
Fazit
Code Reviews sind ein schneller, fokussierter Prozess zur Sicherstellung von verständlichem und gut integriertem Code.