Skip to main content

Issuevorlagen für Dein Repository konfigurieren

Du kannst die Vorlagen anpassen, die für Mitarbeiter zur Verfügung stehen, wenn sie neue Issues in Deinem Repository eröffnen.

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 findest du unter Erstellen einer Standard-Communityintegritätsdatei.

Issuevorlagen erstellen

  1. On GitHub.com, navigate to the main page of the repository. 1. Klicke unter dem Repositorynamen auf Einstellungen. Schaltfläche „Repositoryeinstellungen“
  2. Klicke im Abschnitt „Features“ unter „Issues“ auf Vorlagen einrichten. Schaltfläche zum Starten der Vorlageneinrichtung
  3. Klicke im Dropdownmenü „Add template“ (Vorlage hinzufügen) auf den gewünschten Vorlagentyp, den Du erstellen möchtest. Dropdownmenü „Vorlage hinzufügen“
  4. Um eine Vorschau der Vorlage anzuzeigen oder die Vorlage zu bearbeiten, bevor du sie an das Repository committest, klicke auf Vorschau anzeigen und bearbeiten. Schaltfläche „Vorschau anzeigen und bearbeiten“
  5. Um die Vorlage zu bearbeiten, klicke auf , und ändere die Inhalte der Felder. Schaltfläche „Issuevorlage bearbeiten“
  6. Um automatisch einen standardmäßigen Issuetitel einzurichten, weise den Issue an Benutzern mit Lesezugriff auf das Repository zu. Du kannst auch Kennzeichnungen zur Issuevorlage hinzufügen und diese Details unter „Optional additional Information“ (Optionale zusätzliche Informationen) eingeben. Du kannst diese Details auch in der Issuevorlage mit title, labels oder assignees in einem YAML-Frontmatterformat hinzufügen. Zusätzliche Informationen zu Issuevorlagen
  7. Wenn du mit der Vorschau und Bearbeitung der Vorlage fertig bist, klicke in der oberen rechten Ecke der Seite auf Änderungen vorschlagen. Schaltfläche „Änderungen vorschlagen“
  8. Gib eine Commit-Mitteilung ein, in der Du Deine Änderungen beschreibst. Feld „Commit-Mitteilung für Issuevorlage“
  9. Lege unterhalb der Commit-Mitteilungsfelder fest, ob Du Deine Vorlage direkt an den Standardbranch freigeben oder einen neuen Branch erstellen und einen Pull Request öffnen möchtest. Weitere Informationen zu Pull Requests findest du unter Informationen zu Pull Requests. Auswahl zwischen Commit der Issuevorlage an Mainbranch oder Öffnen eines Pull Requests
  10. Klicke auf Änderungen committen. Sobald diese Änderungen in den Standardbranch zusammengeführt wurden, steht die Vorlage für Mitarbeiter zur Verfügung, wenn sie neue Issues im Repository erstellen.

Erstellen von Issueformularen

Hinweis: Issue-Formulare befinden sich derzeit in Beta für öffentliche Repositorys für GitHub.com.

Mit Issueformularen kannst du Problemvorlagen erstellen, die anpassbare Webformularfelder enthalten. Du kannst Mitwirkende ermutigen, bestimmte, strukturierte Informationen aufzunehmen, indem du Issueformulare in deinem Repository verwendest. Issueformulare werden mithilfe des GitHub-Formularschemas in YAML geschrieben. Weitere Informationen findest du unter Syntax für das Formularschema von GitHub. Wenn du noch nicht mit YAML arbeitest und mehr erfahren möchtest, lies den Artikel zum Erlernen von YAML in Y Minuten.

Um ein Issueformular in deinem Repository zu verwenden, musst du eine neue Datei erstellen und dem Ordner .github/ISSUE_TEMPLATE im Repository hinzufügen.

Hier siehst du ein Beispiel für eine Konfigurationsdatei für Issueformulare:

YAML
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug", "triage"]
assignees:
  - octocat
body:
  - type: markdown
    attributes:
      value: |
        Thanks for taking the time to fill out this bug report!
  - type: input
    id: contact
    attributes:
      label: Contact Details
      description: How can we get in touch with you if we need more info?
      placeholder: ex. email@example.com
    validations:
      required: false
  - type: textarea
    id: what-happened
    attributes:
      label: What happened?
      description: Also tell us, what did you expect to happen?
      placeholder: Tell us what you see!
      value: "A bug happened!"
    validations:
      required: true
  - type: dropdown
    id: version
    attributes:
      label: Version
      description: What version of our software are you running?
      options:
        - 1.0.2 (Default)
        - 1.0.3 (Edge)
    validations:
      required: true
  - type: dropdown
    id: browsers
    attributes:
      label: What browsers are you seeing the problem on?
      multiple: true
      options:
        - Firefox
        - Chrome
        - Safari
        - Microsoft Edge
  - type: textarea
    id: logs
    attributes:
      label: Relevant log output
      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
      render: shell
  - type: checkboxes
    id: terms
    attributes:
      label: Code of Conduct
      description: By submitting this issue, you agree to follow our [Code of Conduct](https://example.com)
      options:
        - label: I agree to follow this project's Code of Conduct
          required: true

Hier siehst du die gerenderte Version des Issueformulars: Gerendertes Issueformular

  1. Wähle ein Repository aus, in dem du ein Issueformular erstellen möchtest. Du kannst ein vorhandenes Repository verwenden, auf das du Schreibzugriff hast, oder du kannst ein neues Repository erstellen. Weitere Informationen zum Erstellen eines Repositorys findest du unter Erstellen eines neuen Repositorys.
  2. Erstelle in deinem Repository eine Datei namens .github/ISSUE_TEMPLATE/FORM-NAME.yml. Ersetze dabei FORM-NAME durch den Namen für dein Issueformular. Weitere Informationen zum Erstellen neuer Dateien auf GitHub findest du unter Erstellen neuer Dateien.
  3. Gib im Textfeld der neuen Datei den Inhalt deines Issueformulars ein. Weitere Informationen findest du unter Syntax für Issueformulare.
  4. Committe deine Workflowdatei in den Standardbranch deines Repositorys. Weitere Informationen findest du unter Erstellen neuer Dateien.

Konfigurieren der Vorlagenauswahl

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.

Du kannst Mitwirkende ermutigen, Issuevorlagen zu verwenden, indem du blank_issues_enabled auf false festlegst. Wenn du blank_issues_enabled auf true festlegst, haben Personen die Möglichkeit, ein leeres Issue zu öffnen.

Hinweis: Wenn du den Legacyworkflow zum manuellen Erstellen einer Datei vom Typ issue_template.md im Ordner .github und Aktivieren von leeren Issues in der Datei config.yml verwendet hast, wird die Vorlage in issue_template.md verwendet, wenn Personen ein leeres Issue öffnen möchten. Wenn Du leere Issues deaktivierst, wird diese Vorlage nie verwendet.

Wenn Du bestimmte Berichte außerhalb von GitHub erhalten möchtest, kannst Du Personen mit contact_links auf externe Websites leiten.

Hier ist ein Beispiel für eine Datei vom Typ config.yml.

YAML
blank_issues_enabled: false
contact_links:
  - name: GitHub Community Support
    url: https://github.com/orgs/community/discussions
    about: Please ask and answer questions here.
  - name: GitHub Security Bug Bounty
    url: https://bounty.github.com/
    about: Please report security vulnerabilities here.

Deine Konfigurationsdatei wird die Vorlagenauswahl anpassen, wenn die Datei in den Standardbranch des Repository zusammengeführt wird.

  1. On GitHub.com, navigate to the main page of the repository. 1. Klicke oberhalb der Dateiliste im Dropdownmenü Datei hinzufügen auf Neue Datei erstellen. „Neue Datei erstellen“ im Dropdownmenü „Datei hinzufügen“
  2. Gib in das Feld für den Dateinamen .github/ISSUE_TEMPLATE/config.yml ein. Konfigurationsdateiname
  3. Gib im Textfeld der neuen Datei den Inhalt Deiner Konfigurationsdatei ein. Inhalt der Konfigurationsdatei 1. Am Ende der Seite schreibe eine kurze, aussagekräftige Commit-Mitteilung, welche die Änderung beschreibt, welche Du an der Datei vornimmst. Du kannst den Commit in der Commit-Mitteilung mehr als einem Autor zuordnen. Weitere Informationen findest du unter Erstellen eines Commits mit mehreren Co-Autoren. Commit-Mitteilung für Ihre Änderung 1. 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 findest du unter Erstellen eines neuen Pull Requests. Commitbranchoptionen 1. Klicke auf Neue Datei vorschlagen. Schaltfläche „Neue Datei vorschlagen“

Weiterführende Themen