Eine Pull-Request-Vorlage für dein Repository erstellen

Wenn du eine Pull-Request-Vorlage zu deinem Repository hinzufügst, sehen Projektmitarbeiter automatisch den Inhalt der Vorlage im Text des Pull Requests.

In diesem Artikel

Weitere Informationen findest du unter Informationen zu Vorlagen für Issues und Pull Requests.

Du kannst in jedem beliebigen unterstützten Ordner ein Unterverzeichnis namens PULL_REQUEST_TEMPLATE erstellen, um mehrere Pull Request-Vorlagen zu speichern. Mit dem Abfrageparameter template kannst du die Vorlage angeben, mit der der Pull Request-Text ausgefüllt werden soll. Weitere Informationen findest du unter Verwenden von Abfrageparametern zum Erstellen eines Pull Requests.

Sie können für Ihre Organisation oder Ihr persönliches Konto Standardvorlagen für Pull Requests erstellen. Weitere Informationen findest du unter Erstellen einer Standard-Community-Health-File.

Eine Pull-Request-Vorlage hinzufügen

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Klicke oberhalb der Dateiliste im Dropdownmenü Datei hinzufügen auf Neue Datei erstellen.

  3. Gib Folgendes im Feld für den Dateinamen ein:

    • Wenn die Pull Request-Vorlage im Stammverzeichnis des Repositorys sichtbar sein soll, benenne diese Vorlage pull_request_template.md.
    • Wenn die Pull Request-Vorlage im docs/pull_request_template.md-Verzeichnis des Repositorys sichtbar sein soll, benenne diese Vorlage docs.
    • Um deine Datei in einem ausgeblendeten Verzeichnis zu speichern, benenne die Pull Request-Vorlage .github/pull_request_template.md.
    • Um mehrere Pull Request-Vorlagen zu erstellen und mithilfe des Abfrageparameters template eine Vorlage zum Ausfüllen des Pull Request-Texts anzugeben, gib .github/PULL_REQUEST_TEMPLATE/ gefolgt vom Namen der Pull Request-Vorlage ein. Beispiel: .github/PULL_REQUEST_TEMPLATE/pull_request_template.md. Du kannst auch mehrere Pull Request-Vorlagen in einem PULL_REQUEST_TEMPLATE-Unterverzeichnis innerhalb des Stammverzeichnisses oder des docs/-Verzeichnisses speichern. Weitere Informationen findest du unter Verwenden von Abfrageparametern zum Erstellen eines Pull Requests.

  4. Füge im Text der neuen Datei deine Pull-Request-Vorlage hinzu. Diese Vorlage könnte darin bestehen, Folgendes einzuschließen:

    • Ein Verweis auf ein verwandtes Issue in deinem Repository.
    • Eine Beschreibung der Änderungen, die im Pull Request vorgeschlagen werden.
    • @mentions der Person oder des Teams, die bzw. das für die Überprüfung vorgeschlagener Änderungen verantwortlich ist.

  5. Gib im Feld „Commitnachricht“ eine kurze, aussagekräftige Commitnachricht ein, die die Änderung beschreibt, die Du an der Datei vorgenommen hast. Du kannst den Commit in der Commit-Mitteilung mehr als einem Autor zuordnen. Weitere Informationen findest du unter Einen Commit mit mehreren Autoren erstellen.

  6. Lege unter den Commit-Mitteilungsfeldern fest, ob Du Dein Commit zum aktuellen Branch oder zu einem neuen Branch hinzufügen möchten. Wenn dein aktueller Branch als Standardbranch festgelegt ist, solltest du einen neuen Branch für deinen Commit und dann einen Pull Request erstellen. Weitere Informationen findest du unter Erstellen eines Pull Requests.

    Screenshot eines GitHub-Pull Requests mit einem Optionsfeld zum direkten Commit an den Mainbranch oder zum Erstellen eines neuen Branchs. Der neue Branch ist ausgewählt.
    Vorlagen sind für Mitarbeiter verfügbar, wenn sie in den Standardbranch des Repositorys gemergt wurden.

  7. Klicke auf Änderungen committen oder Änderungen vorschlagen.

Weiterführende Themen