Manuelles Erstellen einer einzelnen Issuevorlage für dein Repository

Wenn du eine manuell erstellte Issuevorlage zu deinem Repository hinzufügst, sehen Projektmitwirkende automatisch den Inhalt der Vorlage im Text des Issues.

In diesem Artikel

Warnung

Dies ist der Legacy-Workflow zum Erstellen einer Issuevorlage. Wir empfehlen, den aktualisierten Vorlagen-Generator für mehrere Issues oder aber Issueformulare zu verwenden, um Issuevorlagen zu erstellen. Weitere Informationen finden Sie unter Informationen zu Vorlagen für Issues und Pull Requests.

Du kannst in jedem beliebigen unterstützten Ordner ein Unterverzeichnis namens ISSUE_TEMPLATE erstellen, um mehrere Issuevorlagen zu speichern. Mit dem Abfrageparameter template kannst du die Vorlage angeben, mit der der Issuetext ausgefüllt werden soll. Weitere Informationen finden Sie unter Einen Issue erstellen.

Du kannst YAML-Titelei zu jeder Issuevorlage hinzufügen, um den Issuetitel vorab auszufüllen, automatisch Kennzeichnungen und Bearbeiter hinzuzufügen und der Vorlage einen Namen und eine Beschreibung zu geben, die in der Vorlagenauswahl angezeigt wird, die Personen bei Erstellen von neuen Issues in deinem Repository sehen.

Hier ist ein Beispiel für eine YAML-Titelei.

---
name: Tracking issue
about: Use this template for tracking new features.
title: "[DATE]: [FEATURE NAME]"
labels: tracking issue, needs triage
assignees: octocat
---

Hinweis

Wenn ein frontmatter-Wert ein in YAML reserviertes Zeichen wie : enthält, musst du den gesamten Wert in Anführungszeichen setzen. Zum Beispiel: ":bug: Bug" oder ":new: triage needed, :bug: bug".

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 für deine Organisation oder dein persönliches Konto standardmäßige Vorlagen für Issues und eine Standardkonfigurationsdatei für Issues erstellen. Weitere Informationen finden Sie unter Erstellen einer Standard-Community-Health-File.

Eine Issuevorlage hinzufügen

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Wähle über der Dateiliste das Dropdownmenü Add file aus, und klicke dann auf Create new file.

    Alternativ kannst du in der Dateistrukturansicht links auf klicken.

    Screenshot der Hauptseite eines Repositorys, auf dem das Symbol „Add file“ und das Pluszeichen, die beide oben beschrieben wurden, orange umrandet sind.

  3. Gib Folgendes im Feld für den Dateinamen ein:

    • Wenn die Issuevorlage im Stammverzeichnis des Repositorys sichtbar sein soll, gib den Namen deiner issue_template ein. Beispiel: issue_template.md.
    • Wenn die Issuevorlage im docs-Verzeichnis des Repositorys sichtbar sein soll, gib docs/ gefolgt vom Namen deiner issue_template ein. Beispiel: docs/issue_template.md.
    • Um deine Datei in einem ausgeblendeten Verzeichnis zu speichern, gib .github/ gefolgt vom Namen der issue_template ein. Beispiel: .github/issue_template.md.
    • Um mehrere Issuevorlagen zu erstellen und mithilfe des Abfrageparameters template eine Vorlage zum Ausfüllen des Issuetexts anzugeben, gib .github/ISSUE_TEMPLATE/ gefolgt vom Namen der Issuevorlage ein. Beispiel: .github/ISSUE_TEMPLATE/issue_template.md. Du kannst auch mehrere Issuevorlagen in einem ISSUE_TEMPLATE-Unterverzeichnis innerhalb des Stammverzeichnisses oder des docs/-Verzeichnisses speichern. Weitere Informationen finden Sie unter Einen Issue erstellen.

  4. Füge im Text der neuen Datei deine Issuevorlage hinzu. Sie könnte Folgendes enthalten:

    • YAML-Titelei
    • Erwartetes und tatsächliches Verhalten
    • Schritte zum Reproduzieren des Problems
    • Spezifikationen wie die Version des Projekts, des Betriebssystems oder der Hardware 1. Klicke auf Änderungen committen.

  5. Gib im Feld „Commitnachricht“ eine kurze, aussagekräftige Commitnachricht ein, die die Änderung beschreibt, die Du an der Datei vorgenommen hast. Du kannst den Commit in der Commit-Mitteilung mehr als einem Autor zuordnen. Weitere Informationen finden Sie unter Einen Commit mit mehreren Autoren erstellen.

  6. 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 als Standardbranch festgelegt ist, solltest du einen neuen Branch für deinen Commit und dann einen Pull Request erstellen. Weitere Informationen finden Sie unter Erstellen eines Pull Requests.

    Screenshot eines GitHub-Pull Requests mit einem Optionsfeld zum direkten Commit an den Mainbranch oder zum Erstellen eines neuen Branchs. Der neue Branch ist ausgewählt.
    Vorlagen sind für Mitarbeiter beim Mergen in den Standardbranch des Repositorys verfügbar.

  7. Klicke auf Änderungen committen oder Änderungen vorschlagen.

Weiterführende Themen