Pull-Anfragen sind das Lebenselixier eines Repositories. Sie sorgen dafür, dass alles in Bewegung bleibt und gesund bleibt. Auf dieser Seite erfahren Sie, wie Sie einen vollständigen und leicht zu prüfenden PR erstellen, wodurch die Wahrscheinlichkeit steigt, dass Ihre PR zusammengeführt wird.
Hier sind einige Tipps, wie Sie die bestmögliche PR erzielen.
Kommunizieren
Bevor Sie mit dem Schreiben von Code beginnen, sollten Sie mit dem Kernteam kommunizieren, damit es weiß, wofür Sie sich interessieren.
Wenn Sie an einem Problem interessiert sind, geben Sie dazu einen Kommentar ab, in dem Sie angeben, dass Sie damit beginnen werden, daran zu arbeiten. So wird verhindert, dass mehrere Personen an derselben Sache arbeiten. Ein Teammitglied wird sich mit Ihnen in Verbindung setzen, um zu bestätigen, dass es sich um Ihr Konto handelt.
Wenn Sie eine Idee haben, die nicht durch ein Problem abgedeckt ist, erstellen Sie bitte ein Problem, 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 Bau beginnen. Das spart Ihnen auf lange Sicht Arbeit.
Einrichten
Wenn Sie zum ersten Mal einen Beitrag zu Blockly oder blockly-samples leisten, beginnen Sie auf der Seite Entwicklung einrichten.
Weniger ist mehr
Versuchen Sie immer, Ihre Änderungen klein und auf den Punkt zu halten. Wir prüfen lieber mehrere kleinere PRs als eine große. Hier einige Faustregeln:
- Ein Problem beheben Versuchen Sie nicht, mehrere Probleme gleichzeitig anzugehen.
- Begrenzen Sie den Umfang. Normalerweise sollte ein PR weniger als 8 Stunden dauern (je nach Ihrer Vertrautheit mit der Codebasis).
- Verwenden Sie Commits. Wenn Ihr PR etwas zu groß ist, teilen Sie die Änderungen mithilfe von Git-Commits in logische Gruppen auf.
Weniger ist mehr
Warum ist der Codestil wichtig? Wir sind auf langfristigen Erfolg aus und ein einheitlicher Stil erleichtert die Wartung. Der Stil bezieht sich darauf, wie Sie Ihre Variablen benennen, aber auch darauf, wie Sie Ihren Code strukturieren und Kommentare schreiben. Nach Möglichkeit verwenden wir Tools wie eslint, um Stilprüfungen zu automatisieren.
Beachten Sie zusätzlich zu eslint die folgenden Anleitungen:
Änderung testen
Bevor Sie einen Pull-Request erstellen, sollten Sie immer testen, ob Ihre Änderungen funktionieren, damit Sie später nicht noch einmal alles korrigieren müssen. Hier einige Ideen zum Testen der verschiedenen Projektkategorien:
- Für Plug-ins: Schreiben Sie automatisierte Mocha-Tests, die Ihre Änderungen abdecken.
- Beispiele: Testen Sie alle demonstrierten Funktionen manuell.
- codelabs: Führen 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 der Erstellung einer Pressemitteilung: das Verfassen der Zusammenfassung.
Eine gute PR-Zusammenfassung hilft anderen Entwicklern, Ihre Änderungen zu überprüfen. So ist die Wahrscheinlichkeit höher, dass sie schneller akzeptiert werden.
Ihre Zusammenfassung sollte unter anderem Folgendes enthalten:
- Auf welches Problem sich Ihre Anfrage bezieht.
- Welche Änderungen bringt Ihre PR mit sich?
- Wie Sie die Änderung getestet haben.
- Alles, was die Prüfer prüfen sollen.
- Alle anderen Informationen, die Ihrer Meinung nach die Prüfer benötigen.
Wenn Sie beim Erstellen Ihrer Anfrage der PR-Vorlage folgen, sollten Sie gut gerüstet sein. Denken Sie nur daran, so prägnant und vollständig wie möglich zu sein.
Viel Spaß beim Programmieren!