Verwalten und Standardisieren von Pull Requests

Verwalten und standardisieren Sie Pull Requests mithilfe von Vorlagen, Code-Ownern, geschützten Branches, Regelsätzen und automatisierten Tools für konsistente und sichere Beiträge zu Repositorys.

In diesem Artikel

Wenn Sie ein Repository verwalten, können Sie GitHub-Features verwenden, um Pull Requests konsistenter und leichter zu überprüfen. Die Standardisierung hilft Mitwirkenden zu wissen, welche Informationen bereitgestellt werden sollen, hilft Prüfern, sich auf die richtigen Änderungen zu konzentrieren und wichtige Verzweigungen vor versehentlichen oder riskanten Zusammenführungen zu schützen.

Verwenden von Pull Request-Vorlagen

Mithilfe von Pull-Anforderungsvorlagen können Mitwirkende den Kontext bereitstellen, den Ihr Projekt für die Überprüfung benötigt. Eine Vorlage kann Autoren auffordern, den Zweck der Änderung zu erläutern, verwandte Probleme zu verknüpfen, Testnotizen einzuschließen oder eine Checkliste abzuschließen, bevor Sie eine Überprüfung anfordern.

Vorlagen sind nützlich, wenn viele Mitwirkende Pull Requests öffnen oder wenn Ihr Projekt Erwartungen an Reviews hat, die jedes Mal sichtbar sein sollen. Weitere Informationen findest du unter Eine Pull-Request-Vorlage für dein Repository erstellen, Informationen zu Aufgabenlisten und Einen Pull Request zu einem Issue verknüpfen.

Definieren von Codebesitzern

Codebesitzer identifizieren die Personen oder Teams, die für bestimmte Dateien oder Verzeichnisse verantwortlich sind. Wenn ein Pull Request Code ändert, der bestimmten Besitzern zugewiesen ist, kann GitHub automatisch eine Überprüfung durch die richtigen Besitzer anfordern.

Codebesitzer helfen, Rezensionen an Personen mit dem richtigen Kontext weiterzuleiten. Sie sind besonders nützlich für vertrauliche Bereiche wie Sicherheitsdateien, Bereitstellungskonfiguration oder freigegebene Bibliotheken. Siehe Informationen zu Code-Eigentümern.

Verwenden geschützter Branches

Geschützte Filialen tragen dazu bei, wichtige Filialen wie main, stabil zu halten. Sie können Bedingungen wie bestandene Statusprüfungen, signierte Commits oder genehmigte Überprüfungen verlangen, bevor ein Pull Request zusammengeführt werden kann.

Verwenden Sie geschützte Verzweigungen, wenn eine Verzweigung Produktionscode, eine Releasezeile oder eine andere wichtige Quelle der Wahrheit darstellt. Siehe Informationen zu geschützten Branches.

Verwenden von Regelsätzen

Mit Regelsätzen können Sie Repositoryrichtlinien über Zweige und Tags hinweg erzwingen. Sie können Statusprüfungen, Workflows, Pullanforderungsüberprüfungen oder andere Bedingungen erfordern, bevor Änderungen akzeptiert werden.

Regelsätze sind nützlich, wenn Sie konsistente Regeln für mehrere Branches festlegen oder Anforderungen an Überprüfungen mit automatisierten Sicherheitsprüfungen wie der Abhängigkeitsüberprüfung oder dem code scanning Schutz vor dem Zusammenführen kombinieren möchten. Weitere Informationen findest du unter Informationen zu Regelsätzen, Durchsetzen der Abhängigkeitsüberprüfung in einer Organisation und Festlegen des Zusammenführungsschutzes für Codeüberprüfung.

Verwenden von Push-Regelsätzen

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 finden Sie 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.

Pushregeln helfen, riskante Inhalte zu blockieren, bevor sie in das Repository eintritt. Siehe Informationen zu Regelsätzen.

Verwenden von automatisierten Tools zum Überprüfen der Codeformatierung

Automatisierte Tools wie Linters und Formatierer helfen dabei, den Codestil für pull-Anforderungen einheitlich zu halten. Sie können kleine Probleme automatisch abfangen, damit prüfer sich auf Design, Korrektheit und Wartung konzentrieren können.

Sie können diese Tools als Teil eines kontinuierlichen Integrationsworkflows mit GitHub Actionsausführen. Siehe Kontinuierliche Integration (Continuous Integration).