Der Prozess der Codeüberprüfung

Tore

Unser Überprüfungsprozess verfolgt mehrere Ziele:

  • Achten Sie auf eine hohe Qualität des Codes, sowohl in Bezug auf Funktionalität als auch auf Lesbarkeit.
  • Fehler vermeiden: Es kommt zu Fehlern.
  • Sorgen Sie für einen einheitlichen Stil, damit Sie an jedem Teil der Codebasis problemlos mit der Arbeit beginnen können.

Der gesamte Code, der in blockly-Samples und Core Blockly eingespeist wird, wird überprüft, unabhängig davon, ob er von Community-Mitwirkenden oder Blockly-Teammitgliedern geschrieben wurde.

Als Prüfer arbeiten wir mit Ihnen zusammen, damit Ihre Änderung so gut wie möglich ist. Wir möchten Sie als Beitragender bitten, sich mit uns zu unterhalten, um Ihre Pull-Anfragen zu überprüfen und zusammenzuführen.

Vorgehensweise

Die PR-Überprüfung durchläuft mehrere Phasen:

  1. Zuweisung
  2. Feedback
  3. Diskussion
  4. Revision
  5. Wiederholungen
  6. Zusammenführen!

Assignment

Wenn Ihre Pull-Anfrage eingeht, benennt das Bereitschaftsmitglied des Blockly-Teams einen Prüfer.

Die Prüfer werden basierend auf ihrem Fachwissen ausgewählt und die Arbeitslast gleichmäßig verteilt.

Es kann einige Tage dauern, bis ein Prüfer zugewiesen wird, und noch einige Tage, bis eine Rezension angefordert wird. Keine Sorge, das ist normal.

Feedback

Während der Feedbackphase macht ein Prüfer Vorschläge für Änderungen in Ihrer PR. Dabei kann es sich um einfache Dinge handeln, die dafür sorgen, dass der Code den Google JavaScript Styleguides entspricht. Es kann sich auch um größere Dinge handeln, wie die Aufforderung, Ihre Funktionsdefinitionen neu zu organisieren.

Es wird empfohlen, statt einzelner Kommentare die Codeüberprüfungen von GitHub zu nutzen, damit Sie nur eine statt mehrerer Kommentare erhalten.

Diskussion

In der Diskussionsphase haben Sie die Möglichkeit, auf das Feedback zu antworten. Vielleicht war einer der Kommentare in der Rezension unklar: Jetzt haben Sie die Möglichkeit, um eine Klarstellung zu bitten. Vielleicht hat Ihr Prüfer auch eine Änderung beantragt, die Ihrer Meinung nach jedoch Auswirkungen haben wird: Jetzt haben Sie die Chance, einen Kompromiss zu finden.

Überarbeitung

In der Überarbeitungsphase können Sie Änderungen an Ihrer PR vornehmen. Normalerweise sind diese Änderungen das Ergebnis von Aussagen der prüfenden Person in der Feedback-Phase.

Nachdem Sie Ihre Überarbeitungen abgeschlossen haben, kann es hilfreich sein, den Prüfer mit Tags zu versehen und ihn zu bitten, sich die Überarbeitung noch einmal anzusehen.

Wiederholung

Nach der Überarbeitungsphase hat der Prüfer noch einmal die Möglichkeit, Feedback zu geben, und der Prozess beginnt von vorn.

Oft ist eine zweite Überprüfung einfach und konzentriert sich auf cd/m2, z. B. Zeichensetzung und Codestil. Manchmal kann eine zweite Überprüfung jedoch ziemlich umfangreich sein. Der erste Prüfer bittet vielleicht sogar andere Personen um eine neue Perspektive.

Zusammenführen!

In der Zusammenführungsphase haben Sie die Möglichkeit zu feiern. Sie haben eine Änderung erstellt, erörtert und überarbeitet und schließlich zusammengeführt! Dies ist eine große Leistung, die viele Menschen nie beginnen oder geschweige denn abschließen!

Vielen Dank für deinen Einsatz bei der Verbesserung von Blockly. Herzlichen Glückwunsch!