Code-Reviews, um ein besserer Entwickler zu werden
Meiner Erfahrung nach ist die Teilnahme an einem Code-Review der effektivste Weg, um als Entwickler aufzusteigen. Wenn Sie der Ersteller der überprüften Änderungen sind, können Sie direktes Feedback von Ihren Kollegen erhalten. Und wenn Sie einer der Prüfer sind, können Sie verschiedene Ansätze lernen, an die Sie vielleicht nicht gedacht haben, wie man Implementierungen löst.
Aber einen Code-Review richtig zu geben und auch zu verstehen, will gelernt sein. In diesem Artikel werde ich einfach einige Aspekte auflisten, die ich berücksichtige, wenn ich Code-Reviews gebe und erhalte. Aus meiner Sicht haben sie sich als die richtige Wahl für eine kollaborative und einladende Entwicklungsumgebung erwiesen.
Was ich als guten Code definiere
Denken Sie daran, dass es nichts Dauerhafteres gibt als eine vorübergehende Problemumgehung.
Die folgenden Schlüsselmetriken leiten mich beim Schreiben und Überprüfen von Code.
- der Code ist wartbar, z.B. keine Hacks oder Problemumgehungen, jedoch gut dokumentiert
- Der Code ist leicht lesbar, daher ist es viel einfacher, darüber zu argumentieren
- Der Code ist testbar, wodurch die beiden vorherigen Punkte weiter verbessert werden
Wie man einen Code-Review gibt
Demütig sein
Unrecht zu haben ist kein Problem. Darauf zu bestehen, dass Sie Recht haben, obwohl Sie es objektiv nicht sind, ist ein Problem. Denken Sie immer daran, dass Sie möglicherweise etwas übersehen oder den Code einfach falsch verstanden haben. Seien Sie offen für Widerstände und bescheiden für die Chance, etwas Neues zu lernen.
Code-Reviews sind nicht personenbezogen
Denken Sie daran: Der Code kommt zuerst. Sie können den Code von jemandem in einer angespannten Situation überprüfen, in der Sie beide nicht in der Stimmung sind, miteinander zu sprechen, oder allgemein uneins über die aktuelle Funktionsweise der Dinge sind.
Code-Reviews sind nicht der Ort, um Dampf abzulassen oder Frustrationen heimzuzahlen. Der einzige Zweck von Reviews ist die objektive Verbesserung der Codequalität. Der Code, den Sie überprüfen und der zusammengeführt wird, ist der nächste Legacy-Code, daher ist es wichtig, persönliche Dinge beiseite zu lassen und eine objektive Bewertung abzugeben, unabhängig davon, wer der Bewertete ist.
Meinungen sind keine Bewertungen
Ein wesentlicher Unterschied zwischen einer guten Rezension und einem einfachen Kommentar besteht darin, dass Rezensionen Meinungen auslassen. Es spielt beispielsweise keine Rolle, wie der Codestil aussieht, solange er wartbar, leicht lesbar und testbar ist. Wenn Sie sich nicht sicher sind, ob Ihre Bewertung eigensinnig wäre, fügen Sie einfach eine Anmerkung hinzu, damit Sie den Punkt mit Ihrem Kollegen besprechen können.
Gute Bewertungen führen zu guten Gesprächen
Das Anfechten einer Überprüfung kann zu einem großen Wissenstransfer zwischen Entwicklern führen. Eine gegebene Rezension sollte nicht als abschließender Kommentar behandelt werden, sondern als Ausgangspunkt für Diskussionen, um das Gesamtbild zu erhalten. Sie könnten beide etwas übersehen, und die Diskussion der Kritik kann Ihre Erkenntnisse nur verbessern.
Fristen spielen keine Rolle
Nicht immer einfach durchzusetzen, aber das Überspringen von Code-Reviews kann möglicherweise eine große technische Schuld verursachen, die niemand zu bereinigen bereit ist. Es ist wichtig, die notwendige Disziplin zu bewahren, um gründliche Code-Reviews durchzuführen, selbst wenn Sie die Uhr ticken hören. Sie könnten der nächste Entwickler sein, der an diesem Schlamassel arbeitet!
Verwenden Sie Links für Referenzen
Der Vergleich des überprüften Codes mit vorhandenem Code kommt recht häufig vor. Daher ist es wichtig, Verweise über Links korrekt einzufügen. Nur die ungefähre Stelle zu nennen, an der sich der referenzierte Code befindet, reicht nicht aus.
Verwenden Sie die Funktion Ihrer Quellcodeverwaltung, um Code in einem vorhandenen Zweig hervorzuheben, und verwenden Sie die erstellten URLs in Ihrer Überprüfung als Referenz. Gleiches gilt für externe Dokumentationen, beispielsweise auf MDN.
So lesen Sie einen Code-Review
Alles das oben Genannte
Das Lesen von Code-Reviews Ihres Codes macht Sie zu einem besseren Entwickler, wenn Sie alle oben genannten Punkte befolgen. Seien Sie bescheiden, nehmen Sie Kritik nicht persönlich und bemühen Sie sich zu verstehen, worauf eine Bewertung hinweist, um das Gesamtbild besser zu verstehen.
Eine persönliche Meinung darüber, wie man objektiv ist
Dieser Artikel spiegelt meine persönliche Herangehensweise an Code-Reviews wider. Die skizzierten Punkte sind nur eine Zusammenfassung meiner Erfahrung als Entwickler in großen und kleinen Teams, sowohl lokal als auch international. Sie haben sich bewährt, haben zu besserem Code geführt und mir die Möglichkeit gegeben, direkt von anderen zu lernen.
