Artikelversion: Enterprise Server 2.17
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.
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.“
Du kannst Standardvorlagen für Pull-Request für Deine Organisation erstellen. Weitere Informationen findest Du unter „Eine Standard Community-Unterstützungsdatei erstellen."
Eine Pull-Request-Vorlage hinzufügen
- Navigiere in GitHub Enterprise zur Hauptseite des Repository.
- Klicke oberhalb der Dateiliste auf Create new file (neue Datei erstellen).
- 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
. - Um Deine Pull-Request-Vorlage im
docs
-Verzeichnis des Repositorys sichtbar zu machen, benenne diese Vorlagedocs/pull_request_template.md
. - Um Deine Datei in einem versteckten 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-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 UnterverzeichnisPULL_REQUEST_TEMPLATE
innerhalb des Root-Verzeichnisses oder indocs/
-Verzeichnissen speichern. Weitere Informationen findest Du unter „Informationen zur Automatisierung für Issues und Pull-Requests mit Abfrageparametern.“
- Um Deine Pull-Request-Vorlage im Root-Verzeichnis des Repositorys sichtbar zu machen, benenne diese Vorlage
- 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.
- 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"
- 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
Master
ist, solltest Du einen neuen Branch für Deinen Commit erstellen und dann einen Pull-Request erstellen. Weitere Informationen findest Du unter „Erstellen eines neuen Pull-Requests."Vorlagen sind für Mitarbeiter verfügbar, wenn sie in den Standardbranch des Repositorys zusammengeführt wurden. - Klicke auf Propose new file (Neue Datei vorschlagen)