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

Wenn Sie eine Pull-Request-Vorlage zu Ihrem Repository hinzufügen, sehen Projektmitarbeiter automatisch den Inhalt der Vorlage im Text des Pull Requests.

Weitere Informationen findest Du unter „Informationen zu Vorlagen für Issues und Pull Requests

Du kannst in einem der unterstützten Ordner ein Unterverzeichnis PULL_REQUEST_TEMPLATE erstellen, um mehrere Pull-Request-Vorlagen zu speichern. Mit dem Abfrageparameter template kannst Du die Vorlage wählen, mit der der Pull-Request-Text ausgefüllt werden soll. Weitere Informationen findest Du unter „Informationen zur Automatisierung für Issues und Pull Requests mit Abfrageparametern.“

Eine Pull-Request-Vorlage hinzufügen

  1. Navigiere in GitHub AE zur Hauptseite des Repository.
  2. Above the list of files, using the Add file drop-down, click Create new file. "Create new file" in the "Add file" dropdown
  3. Gib Folgendes im Feld für den Dateinamen ein:
    • Um Deine Pull-Request-Vorlage im Root-Verzeichnis des Repositorys sichtbar zu machen, benenne diese Vorlage pull_request_template.md. Root-VerzeichnisName der neuen Pull-Request-Vorlage im Root-Verzeichnis
    • Um Deine Pull-Request-Vorlage im docs-Verzeichnis des Repositorys sichtbar zu machen, benenne diese Vorlage docs/pull_request_template.md. Neue Pull-Request-Vorlage im docs-Verzeichnis
    • Um Deine Datei in einem versteckten Verzeichnis zu speichern, benenne die Pull-Request-Vorlage .github/pull_request_template.md. Neue Pull-Request-Vorlage im ausgeblendeten Verzeichnis
    • Um mehrere Pull-Request-Vorlagen zu erstellen und mithilfe des Abfrageparameters template eine Vorlage zum Ausfüllen des Pull-Request-Textes festzulegen, gib .github/PULL_REQUEST_TEMPLATE/ ein, gefolgt vom Namen der Pull-Request-Vorlage. Beispiel: .github/PULL_REQUEST_TEMPLATE/pull_request_template.md. Du kannst auch mehrere Pull-Request-Vorlagen in einem Unterverzeichnis PULL_REQUEST_TEMPLATE innerhalb des Root-Verzeichnisses oder in docs/-Verzeichnissen speichern. Weitere Informationen findest Du unter „Informationen zur Automatisierung für Issues und Pull Requests mit Abfrageparametern.“ Neue Mehrfach-Pull-Request-Vorlage im ausgeblendeten Verzeichnis
  4. Füge im Text der neuen Datei Deine Pull-Request-Vorlage hinzu. Sie könnte beispielsweise Folgendes enthalten:
    • Einen Verweis auf einen ähnlichen Issue in Deinem Repository.
    • Eine Beschreibung der Änderungen, die im Pull Request vorgeschlagen werden.
    • @Erwähnung der Person oder des Teams, die bzw. das für den Review der vorgeschlagenen Änderungen zuständig ist.
  5. Am Ende der Seite schreibe eine kurze, aussagekräftige Commit-Mitteilung, welche die Änderung beschreibt, welche Du an der Datei vornimmst. Du kannst den Commit in der Commit-Mitteilung mehr als einem Autor zuordnen. Weitere Informationen findest Du unter "Erstellen eines Commit mit mehreren Co-Autoren" Commit-Mitteilung für Deine Änderung
  6. Lege unter den Commit-Mitteilungsfeldern fest, ob Du Deinen Commit zum aktuellen Branch oder zu einem neuen Branch hinzufügen möchtest. If your current branch is the default branch, you should choose to create a new branch for your commit and then create a pull request. Weitere Informationen findest Du unter „Erstellen eines neuen Pull Requests." Branch-Optionen für Commit Vorlagen sind für Mitarbeiter verfügbar, wenn sie in den Standardbranch des Repositorys zusammengeführt wurden.
  7. Klicke auf Propose new file (Neue Datei vorschlagen) Schaltfläche "Propose new file" (Neue Datei vorschlagen)

Weiterführende Informationen

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Oder, learn how to contribute.