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-Community-Health-File.
Issuevorlagen erstellen
- Navigiere auf GitHub.com zur Hauptseite des Repositorys. 1. Klicke unter dem Repositorynamen auf Einstellungen.
- Klicke im Abschnitt „Features“ unter „Issues“ auf Vorlagen einrichten. Möglicherweise musst du „Issues“ aktivieren und die Seite aktualisieren, bevor die Schaltfläche angezeigt wird.
- Klicke im Dropdownmenü „Vorlage hinzufügen“ auf den gewünschten Vorlagentyp, den du erstellen möchtest.
title, labels oder assignees in einem YAML-Frontmatterformat hinzufügen.
8. Wenn du mit der Vorschau und Bearbeitung der Vorlage fertig bist, klicke in der oberen rechten Ecke der Seite auf Änderungen vorschlagen.
Erstellen von Issueformularen
Hinweis: Issueformulare befinden sich derzeit nur für GitHub.com in der Betaphase.
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 GitHub-Formularschema. 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:
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: trueHier siehst du die gerenderte Version des Issueformulars:
- 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 Ein neues Repository erstellen.
- Erstelle in deinem Repository eine Datei namens
.github/ISSUE_TEMPLATE/FORM-NAME.yml. Ersetze dabeiFORM-NAMEdurch den Namen für dein Issueformular. Weitere Informationen zum Erstellen neuer Dateien auf GitHub findest du unter Neue Dateien erstellen. - Gib im Textfeld der neuen Datei den Inhalt deines Issueformulars ein. Weitere Informationen findest du unter Syntax für Issueformulare.
- Committe deine Workflowdatei in den Standardbranch deines Repositorys. Weitere Informationen findest du unter Neue Dateien erstellen.
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.
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.
- Navigiere auf GitHub.com zur Hauptseite des Repositorys. 1. Klicke oberhalb der Dateiliste im Dropdownmenü Datei hinzufügen auf Neue Datei erstellen.
- Gib in das Feld für den Dateinamen
.github/ISSUE_TEMPLATE/config.ymlein.
- Gib im Textfeld der neuen Datei den Inhalt Deiner Konfigurationsdatei ein.
