Pull-Request-Guide für Beitragende


Danke, dass du zu Exercism beitragen möchtest! Bevor du einen Pull Request erstellst, lies bitte den Leitfaden Wie du einen großartigen Pull Request erstellst. Er soll dir bei der nicht-technischen Seite von Pull Requests helfen, damit du eine gute Erfahrung machst und gleichzeitig unser Maintainer-Team unterstützt.

Dieses Dokument enthält einige zusätzliche, Exercism-spezifische Richtlinien für verschiedene Arten von Pull Requests.

Pull Requests für Übungen

Einen Pull Request für eine Konzeptübung oder eine Praxisübung zu erstellen, kann angesichts der vielen Regeln für diese Art von Übungen einschüchternd wirken. Aus diesem Grund kann ein Review durch einen Maintainer zwei bis drei Stunden dauern und zu Dutzenden Kommentaren führen. Um dir zu helfen, gibt es einen Haupt-Reviewer, der deinen Pull Request kommentiert.

Lass dich von der Anzahl der Review-Kommentare nicht entmutigen; es ist völlig normal, dass eine Übung mehrere Überarbeitungen durchläuft, bis sie zu etwas wird, mit dem sowohl du als auch der Haupt-Reviewer zufrieden seid.

Empfehlungen

Hier sind einige Empfehlungen, die den Prozess noch reibungsloser machen.

Lies die Dokumentation

Bevor du einen Pull Request für eine Übung erstellst, lies unbedingt die Dokumentation zu Konzeptübungen bzw. die Dokumentation zu Praxisübungen. Wenn du die Dokumentation vorher liest, hilft das enorm, denn dann gibt es weniger Review-Kommentare und dein Pull Request wird viel schneller gemergt.

Sieh dir vorhandene Übungen an (falls es welche gibt)

Wenn der Track bereits Übungen enthält, nimm dir die Zeit, sie dir etwas genauer anzusehen, um herauszufinden, wie sie aussehen und wie sie aufgebaut sind.

Pull Requests für Praxisübungen

Überlege, ob die Änderung wirklich zu problems-specifications gehört

Einige Inhalte einer Praxisübung (zum Beispiel ihre Einleitung) stammen aus ihren (gemeinsam genutzten) Metadaten, wie sie im problems-specifications-Repo definiert sind. Wenn du solche Inhalte aktualisieren möchtest, überlege, ob die Änderung auch anderen Tracks zugutekommen könnte. Wenn ja, öffne bitte stattdessen einen Pull Request für die Metadaten der Übung im problems-specifications-Repo.

Allgemeine Empfehlungen

Verzichte auf unaufgeforderte Reviews

Alle Pull-Request-Reviews werden von einem (oder mehreren) Maintainern des Tracks durchgeführt, da sie für die Freigabe aller Änderungen am Repository verantwortlich sind. Wenn die Maintainer das Review übernehmen, hilft das auch, widersprüchliches Feedback für die Person, die den Pull Request erstellt hat, zu vermeiden.

Du bist natürlich willkommen, einen Kommentar zu hinterlassen, um Hilfe beim Review anzubieten (besonders bei größeren Pull Requests), oder Fragen zu stellen, falls dir etwas auffällt, das wie ein Fehler aussieht.