Die 10 Gebote des Code-Reviews

Für den Autor

  1. Du sollst einen einheitlichen Merge Request erstellen. 🔢 Ihr Merge Request sollte genau eine Änderung einführen und eine angemessene Größe haben.
  2. Du sollst beschreiben, was dein Code auf einer übergeordneten Ebene tut. ✏️ Sie sollten dem Reviewer genügend Kontext und Informationen geben, damit er versteht, was Sie erreichen wollen.
  3. Du sollst mehrere Reviewer zuweisen. 👪 Je mehr Reviewer Sie haben, desto mehr Fehler können gefunden werden.
  4. Du sollst alle Anmerkungen der Reviewer beantworten. ✅ Alle Anmerkungen haben ihre Berechtigung und sollten berücksichtigt werden. Bedenken Sie beim Beantworten der Anmerkungen, dass für den Gesprächspartner nichts offensichtlich ist.
  5. Du sollst dir nichts persönlich nehmen. ❤️ Es ist immer gut für ein Team, Ideen gegenüberzustellen.

Für den Reviewer

  1. Du sollst jeden Tag Code-Reviews durchführen. ⏰ Code-Review ist gut für Kommunikation und Wissensaustausch.
  2. Du sollst die Beschreibung des Merge Requests lesen, bevor du zum Code springst. 📖 Sie müssen zuerst verstehen, was der Autor ändern möchte, und dann prüfen, ob die Änderung korrekt umgesetzt wurde.
  3. Du sollst präzise sein und vollständige Sätze verwenden. 🔊 Der Autor sollte nicht raten müssen, was Sie sagen wollen. Bedenken Sie bei Anmerkungen, dass für den Gesprächspartner nichts offensichtlich ist.
  4. Du sollst freundlich sein. 👼 „Diese Variable muss in userId umbenannt werden“ vs. „Wie wäre es, diese Variable umzubenennen, um konsistent mit anderen Variablen zu sein?“
  5. Du sollst die OIS-Regel anwenden. 📏 Observe-Impact-Suggest (Beobachten-Auswirkung-Vorschlagen). Beobachten: „Diese Methode hat 100 Zeilen“. Auswirkung: „Es ist für mich schwierig, ihre Logik zu verstehen“. Vorschlagen: „Sie können sie in 2 Methoden mit aussagekräftigen Namen extrahieren“.