Bewährte Methoden für Pull Requests (PRs)

Sie können bewährte Methoden befolgen, um die Konsistenz und Qualität von Pull Requests und Pull Request-Reviews zu verbessern.

In diesem Artikel

Bewährte Methoden für Pull Requests (PRs)

Befolgen Sie beim Erstellen eines Pull Request einige bewährte Methoden für einen reibungsloseren Überprüfungsprozess. Weitere Informationen zum Erstellen eines Pull Request finden Sie unter Erstellen eines Pull Requests.

Schreiben kleiner PRs

Ziel ist es, kleine, fokussierte Pull Requests zu erstellen, die einen einzelnen Zweck erfüllen. Kleinere Pull Requests sind einfacher und schneller zu überprüfen und zusammenzuführen, lassen weniger Platz, um Fehler einzuführen und bieten einen klareren Verlauf der Änderungen.

Überprüfen Ihrer eigenen Pull Requests als Erstes

Überprüfen, erstellen und testen Sie Ihren eigenen Pull Request, bevor Sie ihn übermitteln. Auf diese Weise können Sie Fehler oder Tippfehler erfassen, die Sie möglicherweise verpasst haben, bevor andere mit der Überprüfung beginnen.

Bereitstellen von Kontext und Anleitungen

Schreiben Sie klare Titel und Beschreibungen für Ihre Pull Requests, damit Prüfer schnell verstehen können, was der Pull Request tut. Fügen Sie Folgendes in den Pull Request-Text ein:

  • Zweck des Pull Request
  • einen Überblick über die Änderungen
  • Links zu einem zusätzlichen Kontext, z. B. zum Nachverfolgen von Issues oder früheren Unterhaltungen

Um Prüfern zu helfen, geben Sie den benötigten Feedbacktyp weiter. Benötigen Sie z. B. einen schnellen Blick oder eine tiefergehende Kritik?

Wenn Ihre Pull Request aus Änderungen an mehreren Dateien besteht, geben Sie Prüfern Anleitungen zur Reihenfolge, in der die Dateien überprüft werden sollen. Empfehlen Sie, wo Sie beginnen und wie Sie mit der Überprüfung fortfahren können.

Bewährte Methoden für die Verwaltung von Pull Requests (PRs)

Wenn Sie ein Repositoryverwalter sind, führen Sie diese Schritte aus, um die Pull Requests zu verwalten und zu standardisieren, die Mitwirkende in Ihrem Repository erstellen.

Verwenden von Pull Request-Vorlagen

Mithilfe von Pull Request-Vorlagen können Sie die Informationen anpassen und standardisieren, die Sie einbeziehen möchten, wenn jemand einen Pull Request in Ihrem Repository erstellt. Wenn du eine Pull-Request-Vorlage zu deinem Repository hinzufügst, sehen Projektmitarbeiter automatisch den Inhalt der Vorlage im Text des Pull Requests. Weitere Informationen findest du unter Eine Pull-Request-Vorlage für dein Repository erstellen.

Sie können Pull Request-Vorlagen verwenden, um den Überprüfungsprozess für Ihr Repository zu standardisieren. Sie können z. B. eine Liste von Aufgaben einschließen, die Autoren vor dem Zusammenführen ihrer Pull Requests ausführen möchten, indem Sie der Vorlage eine Aufgabenliste hinzufügen. Weitere Informationen finden Sie unter Informationen zu Aufgabenlisten.

Sie können anfordern, dass Mitwirkende einen Problemverweis in ihren Pull Request-Text einschließen, sodass das Zusammenführen des Pull Request das Issue automatisch schließt. Weitere Informationen findest du unter Einen Pull Request zu einem Issue verknüpfen.

Definieren von Codebesitzern

Möglicherweise möchten Sie sicherstellen, dass bestimmte Personen immer Änderungen an bestimmtem Code oder Dateien in Ihrem Repository überprüfen. Sie können z. B. darauf bestehen, dass ein technischer Redakteur in Ihrem Team immer Änderungen im docs-Verzeichnis überprüft.

Sie können Personen oder Teams definieren, die für den Code oder die Dateien in einem Repository als Codebesitzer verantwortlich sind. Codebesitzer werden automatisch zur Überprüfung aufgefordert, wenn jemand einen Pull Request öffnet, der die Dateien ändert, die sie besitzen. Sie können Codebesitzer für bestimmte Dateitypen oder Verzeichnisse sowie für verschiedene Branches in einem Repository definieren. Weitere Informationen findest du unter Informationen zu Codeinhabern.

Verwenden von geschützten Branches

Sie können geschützte Branches verwenden, um zu verhindern, dass Pull Requests in wichtige Branches zusammengeführt werden, z B. main, bis bestimmte Bedingungen erfüllt sind. Sie können z. B. CI-Tests oder eine Überprüfung für die Genehmigung erfordern. Weitere Informationen findest du unter Informationen zu geschützten Branches.

Verwenden von Pushregelsätzen

Note

Push-Regelsätze befinden sich in der Betaversion. Änderungen sind vorbehalten.

Mit Pushregelsätzen können Sie Pushes an ein privates oder internes Repository blockieren und das gesamte Forknetzwerk dieses Repositorys basierend auf Dateierweiterungen, Dateipfadlängen, Datei- und Ordnerpfaden und Dateigrößen blockieren.

Pushregeln erfordern keine Verzweigungsadressierung, da sie für jeden Push an das Repository gelten.

Push-Regelsätze ermöglichen Folgendes:

  • Einschränken von Dateipfaden: Verhindern Sie bei Commits, die Änderungen in angegebenen Dateipfaden enthalten, dass sie gepusht werden.

    Sie können fnmatch-Syntax hierfür verwenden. Eine Einschränkung, die zum Beispiel auf test/demo/**/* zielt, verhindert Pushes an Dateien oder Ordner im test/demo/-Verzeichnis. Eine Einschränkung mit Ziel test/docs/pushrules.md verhindert Pushs, speziell an die pushrules.md-Datei im test/docs/-Verzeichnis. Weitere Informationen findest du unter Erstellen von Regelsätzen für ein Repository.

  • Dateipfadlänge einschränken: Verhindern Sie Commits, die Dateipfade enthalten, die ein angegebenes Zeichenlimit überschreiten, per Push verschoben werden.

  • Einschränken von Dateierweiterungen: Verhindern Sie Commits, die Dateien mit angegebenen Dateierweiterungen enthalten, pushen.

  • Dateigröße einschränken: Verhindern Sie Commits, die eine angegebene Dateigrößenbeschränkung überschreiten, verschoben werden.

Informationen zu Pushregelsätzen für Fork-Repositorys

Pushregeln gelten für das gesamte Forknetzwerk für ein Repository, um sicherzustellen, dass jeder Einstiegspunkt im Repository geschützt ist. Wenn Sie beispielsweise ein Repository verzweigen, das Push-Regelsätze aktiviert hat, gelten dieselben Push-Regelsätze auch für Ihr Fork-Repository.

Bei einem Fork-Repository sind die einzigen Personen, die über Umgehungsberechtigungen für eine Pushregel verfügen, die Personen, die über Umgehungsberechtigungen im Stamm-Repository verfügen.

Weitere Informationen findest du unter Informationen zu Regelsätzen.

Verwenden von automatisierten Tools zum Überprüfen der Codeformatierung

Verwenden Sie automatisierte Tools wie Linters in den Pull Requests Ihres Repositorys, um konsistente Formatierungen beizubehalten und Code verständlicher zu gestalten. Wenn Sie automatisierte Tools verwenden, um kleinere Probleme wie Tippfehler oder Formatierung zu erfassen, bleibt mehr Zeit für Prüfer, sich auf die Substanz eines Pull Requests zu konzentrieren.

Sie können z. B. GitHub Actions verwenden, um Code-Linters einzurichten, die im Rahmen Ihres CI (Continuous Integration)-Workflows auf Pull Requests ausgeführt werden können. Weitere Informationen findest du unter Informationen zur fortlaufenden Integration.