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 mit dem Issuevorlagen-Generator oder Issueformularen erstellst, können Mitwirkende die geeignete Vorlage auswählen, wenn sie neue Issues im Repository öffnen.
Die Verwendung von Issuevorlagen ist hilfreich, wenn du Anleitungen zum Erstellen von Issues bereitstellen möchtest, während Mitwirkende den Inhalt ihrer Issues selbst festlegen können. Wenn Beitragende spezifische, strukturierte Informationen angeben sollen, wenn sie Issues eröffnen, kannst du mit Issue-Formularen sicherstellen, dass die gewünschten Informationen eingereicht werden.
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 Problemformularen kannst du Vorlagen erstellen, die Webformularfelder mit dem GitHub-Formschema verwenden. 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 finden Sie 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 den Dateinamen von Issuevorlagen wird nicht zwischen Groß- und Kleinschreibung unterschieden, und es wird eine .md-Erweiterung benötigt. Vorlagen, die mit Issue-Formularen erstellt wurden, benötigen eine .yml-Erweiterung. 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.
Du kannst eine Sicherheitsrichtlinie erstellen, um Anweisungen für das Melden von Sicherheitsrisiken in deinem Projekt zu geben. Weitere Informationen finden Sie 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.
Sie müssen Vorlagen auf dem Standardzweig 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 Groß- und Kleinschreibung nicht beachtet, und sie können Erweiterungen wie .md oder .txt haben.
Weitere Informationen finden Sie unter Eine Pull-Request-Vorlage für dein Repository erstellen.