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 für deine Organisation oder dein persönliches Konto Standardvorlagen für Issues und Pull Requests erstellen. Weitere Informationen finden Sie unter Erstellen einer Standard-Community-Health-File.
Vorlagen für Issues
Wenn du Issuevorlagen für dein Repository mithilfe des Vorlagen-Generators für Issues oder mit Issueformularen erstellst, können Mitwirkende die entsprechende Vorlage auswählen, wenn sie neue Issues im Repository erstellen.
Mit Issuevorlagen kannst du Anleitungen zum Erstellen von Issues bereitstellen, wobei Mitwirkende den Inhalt der Issues angeben können. Wenn Mitwirkende beim Erstellen von Issues spezifische, strukturierte Informationen angeben sollen, kannst du mit Issueformularen sicherstellen, dass du die gewünschten Informationen erhältst.
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 finden Sie unter Issuevorlagen für Dein Repository konfigurieren.
Mit Issueformularen kannst du Vorlagen erstellen, die Webformularfelder enthalten, die dem GitHub-Formschema entsprechen. Wenn eine Mitwirkender ein Issue mithilfe des Issueformulars erstellt, werden die Formulareingaben in einen Standardkommentar zum Markdownissue konvertiert. Du kannst unterschiedliche Eingabetypen angeben und Eingaben nach Bedarf so festlegen, dass Mitwirkende Issues in deinem Repository erstellen können. Weitere Informationen findest du unter Issuevorlagen für Dein Repository konfigurieren und Syntax für Issueformulare.
Du kannst die Issuevorlagenauswahl anpassen, die beim Erstellen eines neuen Issues in deinem Repository angezeigt wird, indem du dem Ordner .github/ISSUE_TEMPLATE eine config.yml-Datei hinzufügst. Weitere Informationen findest du unter Issuevorlagen für Dein Repository konfigurieren.
Issuevorlagen werden im Standardbranch des Repositorys im ausgeblendeten Verzeichnis .github/ISSUE_TEMPLATE gespeichert. Wenn du eine Vorlage in einem anderen Branch erstellst, steht sie Mitarbeitern nicht zur Verfügung. Bei Dateinamen von Issuevorlagen wird die Groß- und Kleinschreibung nicht beachtet, und sie müssen die Erweiterung .md aufweisen. Issuevorlagen, die mit Issueformularen erstellt wurden, müssen die Erweiterung .yml aufweisen. Um in der Prüfliste des Communityprofils mit einem -Häkchen angezeigt zu werden, müssen sich Issuevorlagen im Ordner .github/ISSUE_TEMPLATE befinden und gültige name:- und about:-Schlüssel im YAML-Frontmatter (für in .md-Dateien definierte Issuevorlagen) oder gültige name:- und description:-Schlüssel (für in .yml-Dateien definierte Issueformulare) enthalten.
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. Es wird jedoch empfohlen, den upgegradeten Generator für mehrere Vorlagen oder Issueformulare zum Erstellen von Issuevorlagen zu verwenden. Weitere Informationen zum Legacy-Workflow findest du unter Manuelles Erstellen einer einzelnen Issuevorlage für dein Repository.
Du kannst eine Sicherheitsrichtlinie erstellen, um Anweisungen für das Melden von Sicherheitsrisiken in deinem Projekt zu geben. Weitere Informationen findest du unter Hinzufügen einer Sicherheitsrichtlinie für dein Repository.
Pull Request-Vorlagen
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 Pull Request-Vorlage im sichtbaren Stammverzeichnis des Repositorys (dem Ordner docs) oder im ausgeblendeten Verzeichnis .github speichern. Bei Dateinamen von Pull Request-Vorlagen wird nicht nach Groß- und Kleinschreibung unterschieden, und sie können Erweiterungen wie .md oder .txt aufweisen.
Weitere Informationen finden Sie unter Eine Pull-Request-Vorlage für dein Repository erstellen.