Analphabetische Codeüberprüfungen verlangsamen den Workflow erheblich. Wenn eine große Anzahl von Änderungen für einige Tage (oder Wochen!) Feststeckt, muss das Produkt vom Markt genommen werden. Hier sind einige Gründe, warum dies passiert:

Es gibt kein Standard-Code-Design
Keine automatisierten Prüfungen verwendet
Programmierer analysieren ihren Code nicht unabhängig.
Riesige Poolanfragen
Vage Pool-Anfragen
Fehlende Fristen für die Codeüberprüfung

Es gibt kein Standard-Code-Design

Jedes Team sollte einen Code-Format-Standard (Programmierstandard, Styleguide) anwenden, dem alle zustimmen. Es enthält Namenskonventionen, Ordnerstruktur, Code-Formatierung und eine Liste bewährter Methoden wie Unit-Tests, Validierung usw.

Das Fehlen eines klaren Standards und von Konventionen zwingt jeden Entwickler, Code nach Belieben zu schreiben, was zu Code-Streitigkeiten führt. -Rezension. Wenn Sie viele Kommentare zu Formatierungen, Namenskonventionen und vielem mehr sehen, ist es Zeit, über einen gemeinsamen Standard zu sprechen.

Ihr Team kann entweder eigene Empfehlungen entwickeln oder mit bekannten Empfehlungen anderer Unternehmen beginnen. Hier ist ein Beispiel von Google .

Keine automatisierten Prüfungen verwendet

Lernen Sie nach der Übernahme von Codestandards die Tools kennen, um die Einhaltung dieser Standards zu überprüfen. Für fast alle Sprachen gibt es Tools zum Formatieren von Code, Lintern und anderen Dienstprogrammen, die Sie vor dem Festschreiben und Registrieren in CI / CD-Systemen in Hooks einfügen können.

Diese Tools überprüfen den Code auf Übereinstimmung mit den Designstandards und benachrichtigen den Autor über Verstöße. Der Autor hat die Möglichkeit, Probleme zu beheben, bevor eine Poolanforderung gesendet wird, wodurch das Rauschen erheblich reduziert wird. Je mehr Überprüfungen automatisch durchgeführt werden, desto mehr Zeit muss sich der Prüfer auf schwerwiegendere Probleme wie Architekturfehler, Implementierungslücken usw. konzentrieren.

Programmierer analysieren ihren Code nicht unabhängig.

Bevor Sie sich an Kollegen wenden, um eine Codeüberprüfung durchzuführen, muss der Autor seine eigenen Änderungen überprüfen. Es ist so, als würde man den Text eines Briefes auf Tippfehler und Fehler überprüfen, bevor man ihn an den Adressaten sendet.

In der Praxis ist die Validierung Ihres eigenen Codes eine Herausforderung, da Sie dazu neigen, Fehler unbewusst zu überspringen. Hier sind einige Möglichkeiten, um die Qualität der Selbstanalyse zu verbessern:

Stellen Sie eine Poolanfrage, ohne Prüfer zu ernennen, und kehren Sie nach einigen Stunden zu dieser zurück, um einen neuen Blick auf Ihre Änderungen zu werfen.
Unterdrücken Sie Ihre natürliche Tendenz, Änderungen durchzublättern, und betrachten Sie sie stattdessen absichtlich Zeile für Zeile.
Befolgen Sie die Checkliste: Entspricht der Code dem Designstandard? Sind alle geschäftlichen Anforderungen erfüllt? Gibt es Tests für alle möglichen Anwendungsfälle? usw.

Riesige Poolanfragen

Die Anzahl der Kommentare zur Poolanforderung ist umgekehrt proportional zur Anzahl der darin enthaltenen Änderungen. Das heißt, eine große PR → wenige Kommentare, eine kleine PR → viele Kommentare.

Tatsache ist, dass Prüfer die Anforderung eines großen Pools nicht sorgfältig untersuchen, sondern dazu neigen, durch sie zu scrollen, um die Arbeit schneller abzuschließen. Dies widerspricht dem Zweck einer Codeüberprüfung. Manchmal passiert das Gegenteil, wenn der Autor viele Tage lang keine Kommentare erhält, weil der Rezensent Angst hat, zu viel PR zu rezensieren.

Teilen Sie die Poolanforderung in kleinere Teile auf, die getrennt voneinander Sinn machen. So helfen Sie, sie richtig und schnell zu berücksichtigen.

Vage Pool-Anfragen

Oft wird Ihnen eine Poolanfrage mit einer vagen Beschreibung oder ohne diese angeboten. Der Prüfer sollte die Bedeutung der Änderungen verstehen und versuchen, sich an die Aufgabe zu erinnern, die irgendwo in der Besprechung oder im Bug-Tracker besprochen wurde. Daher ist es besser, PR mit unterstützenden Informationen zu versorgen:

Welche Änderungen enthält es
Mit welchen Dateien soll ich beginnen?
Link zur Aufgabe im Bug-Tracker
Screenshots, wenn dies eine Art visuelle Änderung ist

Diese Informationen bieten dem Prüfer einen besseren Kontext und beschleunigen dadurch die Codeüberprüfung.

Fehlende Fristen für die Codeüberprüfung

Eine Möglichkeit, die Codeüberprüfung für immer zu verlängern, besteht darin, keine Fristen für den Prüfer festzulegen. Definieren Sie angemessene Fristen, zum Beispiel:

Der Überprüfungscode sollte innerhalb von 48 Stunden nach dem Senden der Poolanforderung ausgefüllt werden.
Für Hotfixes beträgt der Zeitraum 30 Minuten.

Danke fürs Lesen! :) :)

So beschleunigen Sie die Codeüberprüfung