Informationen zu Vorlagen für Issues und Pull Requests
Mit den Vorlagen für Issues und Pull Requests können Sie die Informationen, die Mitarbeiter beim Öffnen von Issues und Pull Requests in Ihrem Repository berücksichtigen sollen, anpassen und standardisieren.
Inhalt dieses Artikels
Nachdem Sie in Ihrem Repository Vorlagen für Issues und Pull Requests erstellt haben, können Mitarbeiter die Vorlagen verwenden, um Issues zu öffnen oder die vorgeschlagenen Änderungen in ihren Pull Requests gemäß den Beitragsrichtlinien des Repositorys zu beschreiben. Weitere Informationen zum Hinzufügen von Beitragsrichtlinien zu einem Repository finden Sie unter „Richtlinien für Repository-Mitarbeiter festlegen“.
Vorlagen für Issues
Wenn Sie mit dem Issue-Vorlagengenerator Vorlagen für Issues für Ihr Repository erstellen, stehen diese Mitarbeitern zur Verfügung, wenn sie neue Issues im Repository öffnen.
Mit dem Vorlagengenerator können Sie 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-Frontmaterial-Markup hinzu, das erforderlich ist, damit die Vorlage auf der neuen Issue-Seite angezeigt wird. For more information, see "Configuring issue templates for your repository."
Issue-Vorlagen werden auf dem Standardbranch des Repositorys in einem verborgenen .github/ISSUE_TEMPLATE-Verzeichnis gespeichert. Wenn Sie eine Vorlage in einem anderen Branch erstellen, steht sie Mitarbeitern nicht zur Verfügung. Bei den Dateinamen von Issue-Vorlagen wird nicht zwischen Groß- und Kleinschreibung unterschieden, und es wird eine .md-Erweiterung benötigt. To be included in the community profile checklist, issue templates must be located in the .github/ISSUE_TEMPLATE folder and contain valid name: and about: YAML front matter.
Es ist möglich, manuell eine einzelne Issue-Vorlage in Markdown mit dem Workflow für ältere Issue-Vorlagen zu erstellen, wobei die Projektmitarbeiter automatisch den Inhalt der Vorlage im Issue-Text sehen. Wir empfehlen jedoch, den aktualisierten Vorlagengenerator zum Erstellen mehrerer Issues zu verwenden, um Issue-Vorlagen zu erstellen. Weitere Informationen zum veralteten Workflow finden Sie unter „Eine einzelne Issue-Vorlage für Ihr Repository manuell erstellen“.
Vorlagen für Pull Requests
Wenn Sie eine Pull-Request-Vorlage zu Ihrem Repository hinzufügen, sehen Projektmitarbeiter automatisch den Inhalt der Vorlage im Text des Pull Requests.
Vorlagen müssen Sie auf dem Standardbranch des Repositorys erstellen. Vorlagen, die in anderen Branches erstellt wurden, stehen Mitarbeitern nicht zur Verfügung. Sie können Ihre 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 finden Sie unter „Eine Pull-Request-Vorlage für Ihr Repository erstellen“.