Code-Reviews und Genehmigungen

Code-Reviews sind ein Grundpfeiler der modernen Softwareentwicklung. Dabei untersucht eine Gruppe von Entwicklern den Quellcode systematisch, um Fehler zu finden und zu beheben, die in der ursprünglichen Entwicklungsphase übersehen wurden.

Zu den wichtigsten Zielen gehören:

• Codequalität verbessern: Bugs, Sicherheitslücken und Designfehler frühzeitig erkennen.
• Wissen teilen: Das Verständnis der Codebasis im gesamten Team verbreiten.
• Mentoring: Erfahrene Entwickler können weniger erfahrene anleiten, und alle lernen aus unterschiedlichen Perspektiven.

Auf GitHub läuft der Code-Review-Prozess typischerweise in folgenden Schritten ab:

1. Ein Autor erstellt einen Pull Request (PR) mit seinen Änderungen.
2. Der Autor weist Reviewer zu oder fordert Reviews an.
3. Reviewer prüfen den Code und hinterlassen Kommentare und Vorschläge.
4. Der Autor bearbeitet das Feedback und pusht neue Commits in den PR-Branch.
5. Sobald sie zufrieden sind, genehmigen die Reviewer die Änderungen.
6. Schließlich wird der PR in den Main-Branch gemergt.

Bei einem guten Code-Review geht es nicht nur darum, Bugs zu finden, sondern um die allgemeine Verbesserung des Projekts. Achten Sie beim Review auf Folgendes:

• Korrektheit: Tut der Code, was er soll? Gibt es Sonderfälle?
• Lesbarkeit: Ist der Code leicht zu verstehen? Sind die Variablennamen aussagekräftig?
• Wartbarkeit: Können andere den Code später problemlos ändern oder erweitern?
• Performance: Gibt es offensichtliche Ineffizienzen?
• Sicherheit: Werden Sicherheitslücken eingeführt?

Als Reviewer sollte Ihr Feedback stets konstruktiv und respektvoll sein. Denken Sie daran: Sie prüfen den Code, nicht die Person, die ihn geschrieben hat.

Tipps für Feedback:

• Seien Sie konkret: Verweisen Sie auf genaue Codezeilen.
• Erklären Sie das „Warum“: Sagen Sie nicht nur „Ändern Sie das“, sondern erklären Sie, *warum* es geändert werden sollte.
• Schlagen Sie Lösungen vor: Bieten Sie alternative Ansätze oder Codeausschnitte an.
• Bleiben Sie freundlich: Verwenden Sie höfliche Sprache und gehen Sie von guten Absichten aus.

GitHub stellt leistungsstarke Tools bereit, die den Review-Prozess effizienter machen:

• Kommentare zu Zeilen: Klicken Sie im Tab „Files changed“ auf eine Zeile, um direkt einen Kommentar hinzuzufügen.
• Vorschläge: Sie können konkrete Codeänderungen vorschlagen, die der Autor mit einem einzigen Klick übernehmen kann.
• Zusammenfassendes Review: Am Ende können Sie ein zusammenfassendes Review mit dem Status „Comment“, „Approve“ oder „Request changes“ einreichen.

Vorschläge sind besonders für kleine, klare Verbesserungen hilfreich:

// Original Code
- const count = 0;
+ const initialCount = 0; // Better name

Wenn Sie der Autor eines Pull Requests sind, ist es entscheidend, auf Feedback zu reagieren. Damit zeigen Sie, dass Sie engagiert sind und den Code verbessern möchten.

Beim Bearbeiten von Kommentaren:

• Bestätigen Sie den Erhalt: Antworten Sie auf jeden Kommentar, selbst wenn Sie nur „Guter Punkt!“ oder „Erledigt“ schreiben.
• Nehmen Sie Änderungen vor: Pushen Sie neue Commits in Ihren PR-Branch. GitHub aktualisiert den PR automatisch.
• Schließen Sie Diskussionen: Sobald ein Kommentar bearbeitet wurde, markieren Sie ihn auf GitHub als „Resolved“.
• Stellen Sie Fragen: Wenn Sie einen Vorschlag nicht verstehen, bitten Sie um eine Erläuterung.

Der Status „Approve“ ist ein eindeutiges Signal dafür, dass ein Reviewer mit den Änderungen in einem Pull Request zufrieden ist. Viele Repositorys sind so konfiguriert, dass mindestens eine (oder mehrere) Genehmigungen erforderlich sind, bevor ein PR gemergt werden kann.

Eine Genehmigung bedeutet, dass der Reviewer der Ansicht ist, dass der Code:

• die Anforderungen erfüllt.
• gut geschrieben und wartbar ist.
• alle wesentlichen Bedenken berücksichtigt.

Damit ist der Weg für die Integration frei!

Manchmal muss ein Pull Request weiter bearbeitet werden, bevor er gemergt werden kann. In solchen Fällen kann ein Reviewer „Request changes“ als Review-Status auswählen.

Dieser Status macht deutlich:

• Es gibt blockierende Probleme, die behoben werden müssen.
• Der PR kann erst gemergt werden, wenn diese Änderungen vorgenommen wurden und der Reviewer eine neue Genehmigung erteilt.

Verwenden Sie diese Option, wenn die Probleme erheblich sind und verhindern, dass der Code akzeptiert werden kann.

Damit Code-Reviews den größtmöglichen Nutzen bringen, sollten Autoren und Reviewer einige bewährte Vorgehensweisen beachten:

• Halten Sie PRs klein: Kleinere PRs lassen sich einfacher und schneller prüfen.
• Aussagekräftige Beschreibungen: Autoren sollten detaillierte PR-Beschreibungen und Kontext bereitstellen.
• Seien Sie schnell: Reviewer sollten Reviews möglichst schnell durchführen; Autoren sollten zeitnah reagieren.
• Automatisieren Sie, was möglich ist: Verwenden Sie Linter und automatisierte Tests, um einfache Probleme vor dem Review zu erkennen.
• Lernen Sie aus Reviews: Betrachten Sie jedes Review als Gelegenheit, zu lernen und sich zu verbessern.

Welche der folgenden Vorgehensweisen gelten auf Grundlage des Gelernten als gute Praktiken für die Teilnahme an Code-Reviews?

Sie haben die Welt der Code-Reviews und die Genehmigungsfunktionen von GitHub erkundet! Sie haben erfahren, warum Reviews für Codequalität und Wissensaustausch wichtig sind, wie ein typischer Review-Ablauf aussieht und welche Elemente zu guten Review-Praktiken gehören.

Denken Sie daran, stets konstruktives Feedback zu geben, GitHubs Tools wie Vorschläge zu nutzen und beim Review sowie beim Beantworten von Feedback bewährte Vorgehensweisen zu befolgen. „Approve“ und „Request changes“ sind wichtige Signale für die effektive Verwaltung Ihrer PRs.

Üben Sie diese Fähigkeiten weiter, um ein wertvoller Mitarbeiter zu werden!