Effektive Code Reviews Solutions

code-quality.de @FrankS

Effective Code Reviews

Moin!

Frank SonsFrank Sons FrankS FrankS

http://code-quality.dehttp://code-quality.de


Enterprise PHP?


Eine kleine Agenda

Eine Übersicht über Code ReviewsEine Übersicht über Code Reviews

Code Reviews effektiver machenCode Reviews effektiver machen


Schauen wir uns mal die Grundlagen an

Zwei Wege für Code ReviewsZwei Wege für Code Reviews

Erwartungen und die RealitätErwartungen und die Realität

Ein verstecktes ProblemEin verstecktes Problem


Review tools - asynchron


Persönliche Code Reviews


Die richtige Motivation ist wichtig

Zwei Wege für Code ReviewsZwei Wege für Code Reviews




Warum will man Code Reviews?


Die Ergebnisse sehen etwas anders aus...


Es gibt da noch etwas...

Zwei Wege für Code ReviesZwei Wege für Code Revies




Kommt das bekannt vor?

Unstrukturiert und ohne konkrete ZieleUnstrukturiert und ohne konkrete Ziele

Erfolg ist nicht nachvollziehbarErfolg ist nicht nachvollziehbar

Jeder hat seinen LieblingsreviewerJeder hat seinen Lieblingsreviewer


Das Problem:

Ergebnisse basieren auf der Erfahrung,Zeit(-druck) und Motivation des Reviewers.

Ergebnisse basieren auf der Erfahrung,Zeit(-druck) und Motivation des Reviewers.


Nun ja...


Mal schauen, was wir tun können

Eine Übersicht über Code ReviewsEine Übersicht über Code Reviews

Code Reviews effektiver machenCode Reviews effektiver machen


Vergessen wir die tools erst einmal

Gemeinsame Denkweise etablierenGemeinsame Denkweise etablieren

Den richtigen Fokus setzenDen richtigen Fokus setzen

Eine Checkliste verwendenEine Checkliste verwenden


Team Reviews sind eine gute Grundlage


Es kommt Bewegung ins Team

Wissen im Team teilenWissen im Team teilen

Unstimmigkeiten und Missverständnisse aufdeckenUnstimmigkeiten und Missverständnisse aufdecken

Gemeinsames Verständnis von Qualität erzeugenGemeinsames Verständnis von Qualität erzeugen


Das Ziel im Blick behalten





Was wird geprüft?

Metriken zur Code QualitätMetriken zur Code Qualität

Code Verbesserungen und VerständlichkeitCode Verbesserungen und Verständlichkeit


Muss der Code verstanden werden?


Lesbar und verständlich

„Nur wenn man den Code versteht,kann man auch die Fehler finden.“

„Nur wenn man den Code versteht,kann man auch die Fehler finden.“


Ein kleiner, aber wichtiger Unterschied

Coding Style GuideCoding Style Guide

Coding GuidelineCoding Guideline


Was gehört in eine Guideline?

Alles was man nicht automatisiert validieren kann!Alles was man nicht automatisiert validieren kann!


Guidelines sind ein guter Anfang





Eine Checkliste hilft für Reviews!


Beim erstellen der Checkliste...

Jede Regel sollte so konkret wie möglich seinJede Regel sollte so konkret wie möglich sein

Beim erstellen das Team mit einbeziehenBeim erstellen das Team mit einbeziehen

Die Regeln immer mal wieder überprüfenDie Regeln immer mal wieder überprüfen


Ein paar Beispiele:

Funktioniert der Code? Erfüllt er diegeplante Funktion? Ist die Logik korrekt?

Funktioniert der Code? Erfüllt er diegeplante Funktion? Ist die Logik korrekt?

Kategorie: Allgemein


Ein paar Beispiele:

Gibt es überflüssigen oder doppelten Code?Gibt es überflüssigen oder doppelten Code?



Ein paar Beispiele:

Gibt es (überflüssigen) auskommentierten Code?Gibt es (überflüssigen) auskommentierten Code?



Ein paar Beispiele:

Werden alle Dateneingaben überprüft?(z.B. Typ, Länge, Format, Wertebereich, etc.)

Werden alle Dateneingaben überprüft?(z.B. Typ, Länge, Format, Wertebereich, etc.)

Kategorie: Sicherheit


Ein paar Beispiele:

Werden invalide Parameterwerte abgehandelt?Werden invalide Parameterwerte abgehandelt?

Kategorie: Sicherheit


Ein paar Beispiele:

Sind alle Sonderfälle, bzw. spezielles Verhalten beschrieben?

Sind alle Sonderfälle, bzw. spezielles Verhalten beschrieben?

Kategorie: Dokumentation


Ein paar Beispiele:

Ist der Code testbar? Sprich: nicht zu vieleoder versteckte Abhängigkeiten.

Ist der Code testbar? Sprich: nicht zu vieleoder versteckte Abhängigkeiten.

Kategorie: Testing


Ein paar Beispiele:

Testen die Unit Tests auch wirklich,dass der Code die geplante Funktion erfüllt?

Testen die Unit Tests auch wirklich,dass der Code die geplante Funktion erfüllt?

Kategorie: Testing


...und einiges mehr!

Sprachspezifische EigenheitenSprachspezifische Eigenheiten

An euer Team und Projekt angepasstAn euer Team und Projekt angepasst

Nicht zu groß werden lassen!Nicht zu groß werden lassen!


Checklisten machen Reviews effektiver!


Also...

Schafft eine gemeinsames Verständnis für QualitätSchafft eine gemeinsames Verständnis für Qualität

Erstellt Guidelines und eine ChecklisteErstellt Guidelines und eine Checkliste

Code Reviews müssen Teil des Prozesses seinCode Reviews müssen Teil des Prozesses sein


Macht Code Reviews – aber effektive!

„Peer code reviews are the single biggestthing you can do to improve your code.“„Peer code reviews are the single biggestthing you can do to improve your code.“

Jeff Atwood – @codinghorror


Fragen? Feedback?


Links● https://blog.codinghorror.com/code-reviews-just-do-it/● http://blog.codeclimate.com/blog/2013/10/09/unexpected-outcomes-of-code-reviews/● http://blog.fogcreek.com/increase-defect-detection-with-our-code-review-checklist-example/

Technology

Effektive Code Reviews Solutions