Die wichtigsten Aspekte in Code Reviews

Code Reviews sind ein fester Bestandteil unseres Team-Arbeitstages bei der Umsetzung komplexer SPAs für den inhouse-Gebrauch unseres Kunden.

Beim Durchführen der Reviews gilt es, mehrere Dinge im Auge zu behalten und auf Korrektheit zu prüfen, bzw. Fehler zu finden und Auffälligkeiten zu hinterfragen.

Die wichtigsten Aspekte fassen wir im folgenden für euch zusammen.

Vollständige Umsetzung

Beim Reviewen wird in jedem Fall geprüft, ob die zugrundeliegende Anforderung vollständig umgesetzt wurde.

In unserem Fall bedeutet das zu prüfen, ob alle im Ticket festgehaltenen Akzeptanzkriterien vom produzierten Code abgedeckt und erfüllt sind.

Qualität des Codes

Neben der Vollständigkeit achten wir bei Code Reviews stark auf die Qualität bzw. Sauberkeit des Codes. Beispielsweise DRY (Don’t Repeat Yourself), unnötige Komplexität und/oder schwer verständliche Konstrukte, die man bei späteren Wartungsarbeiten eventuell nicht mehr nachvollziehen kann.

Code Style /Konformität mit dem Coding-Agreement

Jedes Projekt hat einen eigenen Stil, in dem Code geschrieben wird. Ob sich dieser über die Projektlaufzeit entwickelt oder in einem Coding-Agreement festgelegt wird, ist dabei nebensächlich.

Ein einheitlicher Stil vereinfacht es den Entwicklern, sich im gesamten Projekt-Code besser zurecht zu finden. (Das können so einfache Dinge sein Leerzeilen vor dem expect-Statement in Tests). Beim Reviewen wird deshalb auch auf die Einhaltung des Projekt-Code-Stils geachtet.

Benutzbarkeit

Auch die Ausführung des Codes, also das Benutzen des neues Features im Browser, ist für uns Bestandteil der Code Reviews. Damit gewährleisten wir, dass sich das neue Feature wie erwartet bedienen lässt und sich optisch korrekt in die bestehende Anwendung einfügt.

Das ersetzt natürlich nicht das Review durch den Product Owner, aber die Anzahl der Review-Schleifen mit dem Product Owner lässt sich hierdurch reduzieren.

Wording

The hardest Part! Bereits beim Code-Style-Aspekt habe ich auf Verständlichkeit, vor allem in Hinblick auf zukünftige Wartung, hingewiesen. Hierzu tragen auch maßgeblich treffende Methoden- und Variablen-Namen bei. Deshalb versuchen wir in Code Reviews auch darauf zu achten, dass diese bestmöglich gewählt werden.

Code Reviews en détail?

Wenn ihr mehr über Code Reviews bei Mayflower erfahren wollt – z. B. „wie“ und „warum“ wir sie machen und welche Alternativen es gibt – kommt doch beim Meetup Code Reviews: Pros, cons, and some experience am 27.04. vorbei!

Fehlen in unserer Liste Aspekte, die euch wichtig sind? Dann ab damit in die Kommentare oder bringt sie mit zum Meetup!

Für neue Blogupdates anmelden:


Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.