Nachdem Du in Deinem Repository Vorlagen für Issues und Pull Requests erstellt hast, können Mitarbeiter die Vorlagen verwenden, um Issues zu öffnen oder vorgeschlagene Änderungen in ihren Pull Requests gemäß den Beitragsrichtlinien des Repositorys zu beschreiben. Weitere Informationen zum Hinzufügen von Beitragsrichtlinien zu einem Repository findest Du unter „Richtlinien für Repository-Mitarbeiter festlegen.“
Du kannst Standardvorlagen für Issues und Pull Request für Deine Organisation erstellen. Weitere Informationen findest Du unter „Erstellen einer Standard-Community-Unterstützungsdatei."
Vorlagen für Issues
Wenn Du mit dem Issue-Vorlagengenerator neue Issuevorlagen für Dein Repository erstellst, stehen diese Mitarbeitern zur Verfügung, wenn sie neue Issues im Repository eröffnen.
Mit dem Vorlagengenerator kannst Du für jede Vorlage einen Titel und eine Beschreibung angeben, den Vorlageninhalt hinzufügen und einen Commit der Vorlage auf dem Standardbranch durchführen oder einen Pull Request im Repository öffnen. Der Vorlagengenerator fügt automatisch das YAML-Titelei-Markup hinzu, das erforderlich ist, damit die Vorlage auf der „Neuer Issue"-Seite angezeigt wird. Weitere Informationen findest Du unter „Issuevorlagen für Dein Repository konfigurieren.“
Issuevorlagen werden auf dem Standardbranch des Repositorys in einem verborgenen .github/ISSUE_TEMPLATE
-Verzeichnis gespeichert. Wenn Du eine Vorlage in einem anderen Branch erstellst, steht sie Mitarbeitern nicht zur Verfügung. Bei den Dateinamen von Issuevorlagen wird nicht zwischen Groß- und Kleinschreibung unterschieden, und es wird eine .md-Erweiterung benötigt. Um in eine Communityprofil-Checkliste aufgenommen zu werden, müssen sich Issuevorlagen im .github/ISSUE_TEMPLATE
-Verzeichnis befinden und müssen gültige name:
und about:
YAML-Titelei-Werte beinhalten.
Es ist möglich, manuell eine einzelne Issuevorlage in Markdown mit dem Workflow für ältere Issuevorlagen zu erstellen, und Projektmitarbeiter werden automatisch den Inhalt der Vorlage im Issue-Text sehen. Wir empfehlen jedoch, den aktualisierten Mehrfach-Issue-Vorlagengenerator zu verwenden, um Issuevorlagen zu erstellen. Weitere Informationen zum veralteten Workflow findest Du unter „Eine einzelne Issue-Vorlage für Dein Repository manuell erstellen.“
Vorlagen für Pull Requests
Wenn Du eine Pull-Request-Vorlage zu Deinem Repository hinzufügst, sehen Projektmitarbeiter automatisch den Inhalt der Vorlage im Text des Pull Requests.
Du musst Vorlagen auf dem Standardbranch des Repositorys erstellen. Vorlagen, die in anderen Branches erstellt wurden, stehen Mitarbeitern nicht zur Verfügung. Du kannst Deine Vorlage für Pull Requests im sichtbaren Stammverzeichnis des Repositorys, im Ordner docs
oder im verborgenen Verzeichnis .github
speichern. Bei den Dateinamen von Pull-Request-Vorlagen wird nicht zwischen Groß- und Kleinschreibung unterschieden, und es kann eine .md- oder .txt-Erweiterung angefügt werden.
Weitere Informationen findest Du unter „Eine Pull-Request-Vorlage für Dein Repository erstellen.“