Pull Requests

Wie du einen großartigen Pull Request erstellst

Pull Requests (PRs) sind der Weg, auf dem du deine vorgeschlagenen Änderungen an einem Teil der Exercism-Codebasis einreichst. Wenn du das hier liest und gerade einen PR zusammenstellst: danke! Dieser Leitfaden soll dir bei der nicht-technischen Seite von PRs helfen, damit du eine großartige Erfahrung machst und gleichzeitig unserem Maintainer-Team hilfst.

Was dich erwartet

Der Ablauf für PRs sieht so aus:

  • Du reichst einen PR ein
  • Ein oder mehrere Maintainer prüfen den PR und hinterlassen Kommentare mit Vorschlägen. In manchen Fällen diskutieren sie den PR als Ganzes und klären, ob es überhaupt das Richtige ist, was hinzugefügt werden soll.
  • Dein PR wird zusammengeführt und du erhältst auf der Website Reputation. Oder dein PR wird geschlossen.

Wie bekomme ich einen PR zusammengeführt?

Es gibt ein paar Dinge, die du im Vorfeld tun kannst, damit dein PR mit möglichst wenigen Änderungen zusammengeführt wird.

Das Wichtigste ist, dass du bevor du den PR einreichst sicherstellst, dass die Maintainer die Änderungen begrüßen, die du machst. Am einfachsten geht das, wenn du zuerst ein Issue auf GitHub öffnest, darin erklärst, was du vorhast, und fragst, ob die Maintainer für diese Änderungen offen sind.

Note

Wenn du auf der Exercism-Website eine Aufgabe findest, musst du kein neues Issue öffnen. Du kannst das vorhandene Issue kommentieren, um zu sagen, dass du daran arbeiten wirst, und dann loslegen.

Als Zweites solltest du beim Öffnen des PRs eine klare Beschreibung hinterlassen. PRs ohne Beschreibung sind für Maintainer unglaublich frustrierend, weil ihnen beim Lesen des Codes der Kontext fehlt. Sag uns, warum du die Änderungen gemacht hast, verlinke das Issue, um das es im PR geht, erkläre alle Kompromisse, die du eingehen musstest, und so weiter.

Und schließlich: Achte darauf, dass dein PR nur Änderungen zu einer einzigen Verbesserung enthält. Wenn du mehrere Verbesserungen hast, verteile sie auf mehrere PRs. Das macht es für Maintainer einfacher und schneller zu prüfen, und es erleichtert auch dir das Leben.

Wie lange sollte ich warten?

Normalerweise prüfen Maintainer deinen PR innerhalb weniger Tage. Bitte hake in der ersten Woche nicht ständig mit zusätzlichen Kommentaren nach. Unsere Maintainer sind Freiwillige und haben viel zu tun, sie kommen so bald wie möglich dazu, ihn zu prüfen. Wenn du innerhalb von 7 Tagen keine Antwort bekommen hast, markiere @exercism/reviewers in einem neuen Kommentar zum PR. Damit wird ein größeres Team darauf aufmerksam.

Vielen Dank noch einmal, dass du zu Exercism beiträgst. Wir hoffen, dass es dir Spaß macht und wertvoll für dich ist!