Guide Lines für Code Reviews von Gitlab

Der Gitlab-Blog schreibt zum Thema Code Reviews:

Wichtige Tools eines Code Reviews:

Self Reviews: Vor dem Zuweisen eines PRs selbst in eine Reviewer-Rolle schlüpfen.
Checkliste: für den Author:
- Jede Code-Zeile nochmal lesen
- Code lokal testen
- Für jede Änderung einen Test schreiben
- Klare Beschreibung schreiben und nach jedem Feedback aktualisieren
- Mindestens einen Screenshot pro PR
- Vorgreifend potentielle Fragen beantworten
Conventionale Kommentare: Emotion/Intention in Kommentaren ausdrücken. Siehe https://conventionalcomments.org/
Patch Files: Kommentare mit Patches versehen, um Vorschläge zu vereinfachen
Fairness: Sowohl als Author als auch als Reviewer:
- Sei belastbar, zuverlässig, fair und respektvoll.
- Suche stets Wege, um zu jedem fair zu sein.
- Als Author: (unter anderem) Versuche Fragen in dem PR zuvorzukommen, und seltsame Teile vorgreifend zu erläutern
- Als Reviewer: Berücksichtige “unbewusste Voreingenommenheit“: Jedes “sollte” oder “muss”/”müsste” muss eine Begründung (Link zu Dokumentation/Konvention) haben, ansonsten ist es nur eine persönliche Präferenz!
- Wenn du anderer Meinung bist: Frage warum, anstatt eine andere Lösung zu verlangen.
Follow Up: Verschiebe größere Anmerkungen/Diskussionen in andere PRs oder Besprechungen.
- Stelle sicher, das diese auch stattfinden!
Die Kunst des GIFs: Nutze GIFs, um PRs emotionaler und menschlicher zu gestalten.
Kleine Iterationen: Breche PRs in kleinere Teile auf. Je kleiner, desto besser zu reviewen!