Das Code Review ist ein unverzichtbares Werkzeug für Entwicklungsteams, um die Codequalität zu gewährleisten. In diesem Artikel geben wir eine kurze Übersicht über die Bedeutung von Code Reviews und die bewährten Praktiken, die dabei beachtet werden sollten. Denn ein gut durchgeführtes Code Review sorgt nicht nur für Zufriedenheit im Team, sondern langfristig auch für zufriedene Nutzer und Auftraggeber.
Warum sind Code Reviews wichtig?
Code Reviews dienen grundsätzlich der Verbesserung der Codebasis-Qualität. Jeder Commit, jeder Merge und jedes neue Feature sollte die Qualität steigern. Ein Code Review ermöglicht es, Fehler und Bugs frühzeitig zu erkennen, um technische Schulden zu vermeiden und langfristig Zeit zu sparen.
Neben funktionalen Fehlern können beim Code Review auch Punkte wie Architektur und Code Style angesprochen werden. Solche Aspekte tragen ebenfalls zur Qualität des Codes bei, lassen sich jedoch nicht durch Automatisierungstools wie Unit Tests überprüfen.
Wie führt man ein Code Review durch?
Bevor das Code Review beginnt, ist es wichtig sicherzustellen, dass alle Teilnehmer auf dem aktuellen Stand sind. Das betrifft sowohl den Kenntnisstand des Codes als auch die Version des Codes. Die Personen, die das Review durchführen, müssen verstehen, was der Code bewirken soll. Schließlich kann Code, von dem man nichts weiß, nur schwer überprüft werden. Außerdem ist es wichtig, dass alle Tests erfolgreich durchlaufen werden, bevor das Code Review startet. Es macht wenig Sinn, funktional fehlerhaften Code auf Qualität zu überprüfen.
Code Reviews können auf verschiedene Arten stattfinden: persönlich oder remote, gemeinsam im Team oder eins zu eins, als eigenes Meeting oder über Kommunikationstools. Die Schritte bleiben dabei gleich, nur der Umfang des Inputs und die Länge des Feedback-Zyklus können variieren.
Die erste Aufgabe beim Code Review besteht darin, den Code zu überprüfen, zu verstehen und anhand festgelegter Kriterien zu bewerten. Wenn Mängel festgestellt werden, ist es wichtig, diese anzusprechen und konstruktive Kritik zu üben. Es reicht jedoch nicht aus, nur die Fehler aufzuzeigen. Es müssen auch Lösungsvorschläge präsentiert werden, am besten anhand konkreter Beispiele.
Um den Überblick beim Code Review nicht zu verlieren, empfiehlt es sich, eine Checkliste zu verwenden. Eine Checkliste hilft dabei, eine Struktur in das Code Review zu bringen und sicherzustellen, dass nichts vergessen wird.
Was sollte beachtet werden?
Es ist wichtig, das Code Review nicht zu umfangreich zu gestalten. Von zu vielen Codezeilen überfordert zu werden, führt oft dazu, dass weniger kritisch bewertet wird. Außerdem sollte das Code Review nicht zu lange dauern, da sonst die Konzentration nachlässt und Fehler übersehen werden können.
Um die Codequalität objektiv bewerten zu können, sind konkrete Metriken erforderlich. Diese können bestimmte Werte sein, wie z.B. die Testabdeckung in Prozent, oder Richtlinien, die eingehalten werden müssen, wie z.B. ein Style Guide. Idealerweise verwendet das Team dafür auch Tools, die automatisch Warnungen generieren. Statische Codeanalyse-Tools erkennen häufig auftretende Fehlerquellen, die dann ohne viel Diskussion behoben werden können. Diese Tools sollten bereits während der Entwicklung eingesetzt werden, um Fehler frühzeitig zu erkennen und nicht erst beim Code Review anzusprechen.
Der wichtigste Punkt beim Code Review hat weniger mit der Technik als mit dem Zwischenmenschlichen zu tun. Es ist wichtig, dass Kritik konstruktiv geäußert wird, um den Code zu verbessern. Es geht nicht darum, zu zeigen, wie gut man selbst programmieren kann oder sein Gegenüber herabzusetzen. Der Fokus sollte darauf liegen, die Qualität des Codes zu steigern. Dazu ist es wichtig, sachliche Kritik zu üben, Begründungen zu geben und den Code-Autor nicht persönlich anzugreifen. Es ist auch erlaubt, positive Aspekte zu erwähnen. Im Code Review sollte generell eine positive Stimmung herrschen, denn das ist auch am effektivsten.
Code Review Checklisten
Wie bereits erwähnt, können Checklisten eine große Hilfe beim Code Review sein, um sicherzustellen, dass nichts übersehen wird. Auf einer Checkliste werden die Merkmale notiert, auf die der Code überprüft werden soll. Das Team entscheidet, welche Kriterien auf der Checkliste stehen. Wenn ein Team noch keine Checkliste hat, sollte zunächst eine kleine Checkliste erstellt werden. Mit der Zeit kann diese erweitert und verbessert werden, je nach den Bedürfnissen des Teams. Mit einer qualitativ hochwertigen Checkliste verbessert sich auch die Qualität des Code Reviews und somit des Codes selbst.
Beispielhafte Starter-Checkliste:
- Der Code ist verständlich.
- Die festgelegten Code-Standards werden eingehalten.
- Es gibt Tests für die Änderungen.
- Der Code erfüllt die technischen Anforderungen.
Zur Profi-Checkliste: Sie möchten Ihren Code einfach und schnell auf Qualität überprüfen?
Hier finden Sie die konkrete Objectbay Code Review Checkliste, die Sie Schritt für Schritt durch den Review-Prozess führt.
Bildquelle: Original-Artikel
