Informationen zur YAML-Syntax für Diskussionskategorieformulare
Du kannst benutzerdefinierte Diskussionskategorieformulare erstellen, indem du dem Ordner /.github/DISCUSSION_TEMPLATE/ in deinem Repository eine YAML-Formulardefinitionsdatei hinzufügst. Wenn du noch nicht mit YAML arbeitest und mehr erfahren möchtest, lies den Artikel zum Erlernen von YAML in Y Minuten.
Du kannst für jedes Feld den Eingabetyp, die Validierung und eine Standardbezeichnung definieren.
Wenn ein Communitymitglied ein Diskussionsformular ausfüllt, werden seine Antworten für jede Eingabe in Markdown konvertiert und dem Diskussionsinhalt hinzugefügt. Communitymitglieder können ihre Diskussionen bearbeiten, die mit einem Diskussionsformular erstellt wurden, und andere Personen können mit der Diskussion wie mit einer Diskussion interagieren, die mit anderen Methoden erstellt wurde.
In dieser YAML-Beispielkonfigurationsdatei wird ein allgemeines Diskussionskategorieformular definiert.
Syntax auf oberster Ebene
Die Konfigurationsdatei für ein Diskussionskategorieformular muss einen body-Schlüssel enthalten, und body muss mindestens ein Feld ohne Markdown enthalten.
body:
- type: input
id: suggestion
attributes:
label: Suggestion
description: "How might we make this project better?"
placeholder: "Adding a CODE_OF_CONDUCT.md file would be a great idea."
validations:
required: true
body:
- type: input
id: suggestion
attributes:
label: Suggestion
description: "How might we make this project better?"
placeholder: "Adding a CODE_OF_CONDUCT.md file would be a great idea."
validations:
required: true
Sie können für jedes Diskussionskategorieformular die folgenden Schlüssel der obersten Ebene festlegen.
| Schlüssel | BESCHREIBUNG | Erforderlich | Typ |
|---|---|---|---|
body | Definition der Eingabetypen im Diskussionsformular. | Erforderlich | Array |
labels | Bezeichnungen, die automatisch den mit dieser Vorlage erstellten Diskussionen hinzugefügt werden. | Optional | Array oder mit Komma getrennte Zeichenfolge |
title | Ein Standardtitel, der im Diskussionsformular automatisch ausgefüllt wird. | Optional | String |
Um Felder zum Formular hinzuzufügen, füge ein Array von Formularelementen in den body-Schlüssel ein. Eine Liste der verfügbaren Elemente und ihrer Syntax findest du unter Syntax für das Formularschema von GitHub.