Gute Pull-Anfrage schreiben

Pull-Anfragen sind wie das Lebensfreude eines Repositorys. Sie sorgen dafür, dass alles gesund und in Bewegung bleibt. Auf dieser Seite wird beschrieben, wie Sie eine vollständige und einfach zu überprüfende PR erstellen. Dadurch steigt die Wahrscheinlichkeit, dass Ihr PR zusammengeführt wird.

Die folgenden Schritte können Ihnen dabei helfen, die bestmögliche PR zu erstellen.

  1. Kommunizieren
  2. Jetzt einrichten
  3. Klein und klein
  4. Immer sauber bleiben
  5. Änderung testen
  6. Kommunikation (Teil 2)

Kommunizieren

Bevor Sie mit dem Schreiben von Code beginnen, sollten Sie mit dem Kernteam kommunizieren, damit es weiß, woran Sie interessiert sind.

Wenn Sie an einem Problem interessiert sind, geben Sie einen Kommentar dazu ab, in dem Sie angeben, dass Sie an einer Lösung arbeiten werden. So stellen wir sicher, dass nicht mehrere Personen an derselben Aufgabe arbeiten. Ein Teammitglied wird antworten, um zu bestätigen, dass es sich um Ihre Person handelt.

Wenn Sie eine Idee haben, die nicht durch ein Problem abgedeckt ist, schreiben Sie eine Idee, bevor Sie mit der Arbeit beginnen. So hat das Team die Möglichkeit, zu besprechen, wie die Änderung am besten umgesetzt werden kann, bevor Sie mit dem Erstellen beginnen. Dadurch sparen Sie langfristig Arbeit.

Jetzt einrichten

Wenn Sie zum ersten Mal zu Blockly- oder Blockly-Beispielen beitragen, beginnen Sie mit der Einrichtungsseite für die Entwicklung.

Halten Sie es klein

Versuchen Sie immer, kleine und gezielte Änderungen vorzunehmen. Wir würden lieber mehrere kleinere PRs überprüfen als eine riesige PR. Einige gute Faustregeln sind:

  • Ein Problem beheben Versuchen Sie nicht, mehrere Probleme auf einmal anzugehen.
  • Beschränken Sie den Umfang. Normalerweise sollte eine PR weniger als 8 Stunden dauern (je nachdem, wie gut Sie sich mit der Codebasis auskennen).
  • Verwenden Sie Commits. Wenn sich Ihre PR-Abteilung etwas zu groß anfühlt, teilen Sie die Änderungen mithilfe von Git-Commits in logische Gruppen auf.

Sauber halten

Warum ist der Codestil wichtig? Wir sind langfristig dran und ein einheitlicher Stil erleichtert die Wartung. Der Stil bezieht sich auf die Benennung Ihrer Variablen, aber auch darauf, wie Sie Ihren Code strukturieren, Kommentare schreiben und vieles mehr. Wenn möglich, verwenden wir Tools wie eslint, um Stilprüfungen zu automatisieren.

Beachten Sie zusätzlich zu eslint die folgenden Leitfäden:

Änderung testen

Bevor Sie eine PR einrichten, sollten Sie immer testen, ob Ihre Änderungen funktionieren, damit Sie später nicht zurückkehren und Probleme beheben müssen. Hier sind einige Ideen zum Testen der verschiedenen Projektkategorien:

  • Für Plug-ins: Schreiben Sie automatisierte Mocha-Tests, die Ihre Änderungen abdecken.
  • Beispiele: Testen Sie die demonstrierten Funktionen manuell.
  • Bei Codelabs: Arbeiten Sie die gesamte Anleitung in einer sauberen Umgebung durch und testen Sie den von Ihnen bereitgestellten Beispielcode.

Kommunizieren

Dies ist der letzte und wohl wichtigste Teil beim Erstellen einer PR: das Verfassen der Zusammenfassung.

Wenn Sie eine gute PR-Zusammenfassung schreiben, können andere Entwickler Ihre Änderungen besser prüfen. Dadurch steigt die Wahrscheinlichkeit, dass sie schneller akzeptiert werden.

Die Zusammenfassung sollte Folgendes enthalten:

  • Auf welches Problem sich Ihre PR bezieht.
  • Was ändert sich durch die PR-Informationen?
  • Wie Sie Ihre Änderung getestet haben.
  • Alles, was Prüfer genau untersuchen sollen.
  • Alle anderen Informationen, die die Prüfer Ihrer Meinung nach benötigen.

Wenn Sie sich beim Erstellen Ihrer Anfrage an die PR-Vorlage halten, sollten Sie nichts weiter tun. Achten Sie aber darauf, möglichst präzise und vollständig zu sein.

Viel Spaß beim Programmieren!