Hinweis: Issueformulare befinden sich derzeit in der Betaphase und können geändert werden.
Erforderlicher Schlüssel oberster Ebene (name) fehlt
Die Vorlage enthält kein name-Feld. Folglich ist nicht klar, welche Bezeichnung für deine Issuevorlage verwendet werden soll, wenn Benutzer*innen eine Liste verschiedener Optionen angezeigt wird.
Beispiel für den Fehler „Erforderlicher name-Schlüssel der obersten Ebene fehlt“
description: "Thank you for reporting a bug!"
...
Der Fehler kann behoben werden, indem name als Schlüssel hinzufügt wird.
name: "Bug report"
description: "Thank you for reporting a bug!"
...
key muss eine Zeichenfolge sein
Diese Fehlermeldung bedeutet, dass ein zulässiger Schlüssel angegeben wurde, der Wert jedoch nicht analysiert werden kann, weil der Datentyp nicht unterstützt wird.
Beispiel für den Fehler „key muss eine Zeichenfolge sein“
Der description-Wert unten wird als boolescher Wert analysiert, es sollte jedoch eine Zeichenfolge sein.
name: "Bug report"
description: true
...
Der Fehler kann behoben werden, indem eine Zeichenfolge als Wert angegeben wird. Für eine erfolgreiche Analyse müssen Zeichenfolgen gegebenenfalls in doppelte Anführungszeichen eingeschlossen werden. Zeichenfolgen mit ' müssen z. B. in doppelte Anführungszeichen gesetzt werden.
name: "Bug report"
description: "true"
...
Leere Zeichenfolgen oder Zeichenfolgen, die nur aus Leerzeichen bestehen, sind ebenfalls unzulässig, wenn für das Feld eine Zeichenfolge erwartet wird.
name: ""
description: "File a bug report"
assignees: " "
...
Der Fehler kann behoben werden, indem der Wert korrigiert und in eine nicht leere Zeichenfolge geändert wird. Wenn das Feld nicht erforderlich ist, solltest du das Schlüssel-Wert-Paar löschen.
name: "Bug Report"
description: "File a bug report"
...
input ist kein zulässiger Schlüssel
Auf oberster Ebene der Vorlage wurde ein unerwarteter Schlüssel angegeben. Weitere Informationen zu den unterstützten Schlüsseln oberster Ebene findest du unter Syntax für Issueformulare.
Beispiel für den Fehler „input ist kein zulässiger Schlüssel“
name: "Bug report"
hello: world
...
Der Fehler kann behoben werden, indem die unerwarteten Schlüssel entfernt werden.
name: "Bug report"
...
Unzulässige Schlüssel
YAML analysiert bestimmte Zeichenfolgen als Boolean-Werte. Damit dies vermieden wird, wurde die Verwendung der folgenden Schlüssel explizit untersagt:
y, Y, yes, Yes, YES, n, N, no, No, NO, true, True, TRUE, false, False, FALSE, on, On, ON, off, Off, OFF
Der Fehler kann behoben werden, indem die unzulässigen Schlüssel entfernt werden.
Der Text muss mindestens ein Nicht-Markdown-Feld enthalten
Issue-Formulare müssen Benutzereingaben akzeptieren, es muss also mindestens ein Benutzereingabefeld enthalten sein. Da ein markdown-Element statischer Text ist, darf ein body-Array nicht ausschließlich markdown-Elemente enthalten.
Beispiel für den Fehler „body muss mindestens ein Nicht-Markdown-Feld enthalten“
name: "Bug report"
body:
- type: markdown
attributes:
value: "Bugs are the worst!"
Der Fehler kann behoben werden, indem Nicht-Markdown-Elemente hinzugefügt werden, die Benutzereingaben akzeptieren.
name: "Bug report"
body:
- type: markdown
attributes:
value: "Bugs are the worst!"
- type: textarea
attributes:
label: "What's wrong?"
Der Text muss eindeutige IDs aufweisen
Wenn du id-Attribute verwendest, um zwischen mehreren Elementen zu unterscheiden, muss jedes id-Attribut eindeutig sein.
Beispiel für den Fehler „body muss eindeutige IDs aufweisen“
name: "Bug report"
body:
- type: input
id: name
attributes:
label: First name
- type: input
id: name
attributes:
label: Last name
Der Fehler kann behoben werden, indem der id-Wert für eine dieser Eingaben geändert wird, damit jedes input-Feld über ein eindeutiges id-Attribut verfügt.
name: "Bug report"
body:
- type: input
id: name
attributes:
label: First name
- type: input
id: surname
attributes:
label: Last name
Der Text muss eindeutige Bezeichnungen aufweisen
Wenn mehrere body-Elemente vorhanden sind, die Benutzereingaben akzeptieren, muss das label-Attribut für jedes Benutzereingabefeld eindeutig sein.
Beispiel für den Fehler „body muss eindeutige Bezeichnungen aufweisen“
name: "Bug report"
body:
- type: textarea
attributes:
label: Name
- type: textarea
attributes:
label: Name
Der Fehler kann behoben werden, indem das label-Attribut für eins der Eingabefelder so geändert wird, dass jeder label-Wert eindeutig ist.
name: "Bug report"
body:
- type: textarea
attributes:
label: Name
- type: textarea
attributes:
label: Operating System
Zwischen Eingabefeldern kann anhand ihres id-Attributs unterschieden werden. Wenn doppelte label-Attribute erforderlich sind, kannst du mindestens einen id-Wert angeben, um zwischen zwei Elementen mit identischen Bezeichnungen zu unterscheiden.
name: "Bug report"
body:
- type: textarea
id: name_1
attributes:
label: Name
- type: textarea
id: name_2
attributes:
label: Name
id-Attribute sind im Issue-Text nicht sichtbar. Wenn du im resultierenden Issue zwischen den Feldern unterscheiden können möchtest, solltest du unterschiedliche label-Attribute verwenden.
Bezeichnungen sind zu ähnlich
Ähnliche Bezeichnungen können in identische Verweise verarbeitet werden. Wenn kein id-Attribut für einen input-Wert angegeben wird, wird das label-Attribut verwendet, um einen Verweis auf das input-Feld zu generieren. Dazu wird label mit der Rails-Methode parameterize verarbeitet. In einigen Fällen können zwei unterschiedliche Bezeichnungen in dieselbe parametrisierte Zeichenfolge verarbeitet werden.
Beispiel für den Fehler „label-Attribute sind zu ähnlich“
name: "Bug report"
body:
- type: input
attributes:
label: Name?
- type: input
id: name
attributes:
label: Name???????
Der Fehler kann behoben werden, indem mindestens ein anderes alphanumerisches Zeichen, - oder _ zu einer der Bezeichnungen hinzugefügt wird, bei denen es zu einem Konflikt kommt.
name: "Bug report"
body:
- type: input
attributes:
label: Name?
- type: input
attributes:
label: Your name
Der Fehler kann auch behoben werden, indem einer der Bezeichnungen ein eindeutiger id-Wert zugewiesen wird.
name: "Bug report"
body:
- type: input
attributes:
label: Name?
- type: input
id: your-name
attributes:
label: Name???????
Kontrollkästchen müssen eindeutige Bezeichnungen aufweisen
Wenn ein checkboxes-Element vorhanden ist, müssen alle geschachtelten Bezeichnungen innerhalb der Peers sowie innerhalb von anderen Eingabetypen eindeutig sein.
Beispiel für den Fehler „checkboxes-Element muss eindeutige Bezeichnungen aufweisen“
name: "Bug report"
body:
- type: textarea
attributes:
label: Name
- type: checkboxes
attributes:
options:
- label: Name
Der Fehler kann behoben werden, indem das label-Attribut für eine dieser Eingaben geändert wird.
name: "Bug report"
body:
- type: textarea
attributes:
label: Name
- type: checkboxes
attributes:
options:
- label: Your name
Alternativ kannst du einen id-Wert für eins der Elemente oberster Ebene angeben, bei denen es zu Konflikten kommt. Geschachtelte Kontrollkästchenelemente unterstützen das id-Attribut nicht.
name: "Bug report"
body:
- type: textarea
id: name_1
attributes:
label: Name
- type: checkboxes
attributes:
options:
- label: Name
id-Attribute sind im Issue-Text nicht sichtbar. Wenn du im resultierenden Issue zwischen den Feldern unterscheiden können möchtest, solltest du unterschiedliche label-Attribute verwenden.
Body[i]: erforderlicher Schlüsseltyp fehlt
Jeder Textblock muss den Schlüssel type enthalten.
Bei Fehlern mit body wird das Präfix body[i] hinzugefügt, wobei i für den nullindizierten Index des Textblocks mit dem Fehler steht. body[0] weist z. B. darauf hin, dass der Fehler durch den ersten Block in der body-Liste verursacht wurde.
Beispiel für den Fehler „body[i]: Erforderlicher Schlüsseltyp fehlt“
body:
- attributes:
value: "Thanks for taking the time to fill out this bug! If you need real-time help, join us on Discord."
Der Fehler kann behoben werden, indem der Schlüssel type mit einem gültigen Eingabetyp als Wert hinzugefügt wird. Die verfügbaren body-Eingabetypen und ihre Syntax findest du unter Syntax für das GitHub-Formularschema.
body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug! If you need real-time help, join us on Discord."
Body[i]: x ist kein gültiger Eingabetyp
Einer der Textblöcke enthält einen Typwert, der kein zulässiger Typ ist.
Bei Fehlern mit body wird das Präfix body[i] hinzugefügt, wobei i für den Index des Textblocks mit dem Fehler steht. body[0] weist z. B. darauf hin, dass der Fehler durch den ersten Block in der body-Liste verursacht wurde.
Beispiel für den Fehler „body[i]: x ist kein gültiger Eingabetyp“
body:
- type: x
attributes:
value: "Thanks for taking the time to fill out this bug! If you need real-time help, join us on Discord."
Der Fehler kann behoben werden, indem x in einen gültigen Typ geändert wird.
body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug! If you need real-time help, join us on Discord."
Body[i]: erforderlicher Attributschlüssel value fehlt
Eins der erforderlichen value-Attribute wurde nicht angegeben. Der Fehler tritt auf, wenn ein Block nicht über einen attributes-Schlüssel oder nicht über einen value-Schlüssel unterhalb des attributes-Schlüssels verfügt.
Bei Fehlern mit body wird das Präfix body[i] hinzugefügt, wobei i für den Index des Textblocks mit dem Fehler steht. body[0] weist z. B. darauf hin, dass der Fehler durch den ersten Block in der body-Liste verursacht wurde.
Beispiel für den Fehler „body[i]: Erforderlicher Attributschlüssel value fehlt“
body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug! If you need real-time help, join us on Discord."
- type: markdown
Der Fehler in diesem Beispiel kann behoben werden, indem value als Schlüssel unter attributes im zweiten Listenelement von body hinzugefügt wird.
body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug! If you need real-time help, join us on Discord."
- type: markdown
attributes:
value: "This is working now!"
Body[i]: Bezeichnung muss eine Zeichenfolge sein
Ein Wert innerhalb des attributes-Blocks weist den falschen Datentyp auf.
Bei Fehlern mit body wird das Präfix body[i] hinzugefügt, wobei i für den Index des Textblocks mit dem Fehler steht. body[0] weist z. B. darauf hin, dass der Fehler durch den ersten Block in der body-Liste verursacht wurde.
Beispiel für den Fehler „body[i]: label muss eine Zeichenfolge sein“
Der label-Wert unten wird als boolescher Wert analysiert, es sollte jedoch eine Zeichenfolge sein.
body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug! If you need real-time help, join us on Discord."
- type: textarea
attributes:
label: Bug Description
- type: textarea
attributes:
label: true
Der Fehler kann behoben werden, indem ein Zeichenfolgenwert für label angegeben wird. Wenn du einen label-Wert verwenden möchtest, der als boolescher Wert, ganze Zahl oder Dezimalzahl analysiert werden kann, setze den Wert in Anführungszeichen. Verwende z. B. "true" oder "1.3" anstelle von true oder 1.3.
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug! If you need real-time help, join us on Discord."
- type: textarea
attributes:
label: Bug Description
- type: textarea
attributes:
label: Environment Details
Leere Zeichenfolgen oder Zeichenfolgen, die nur aus Leerzeichen bestehen, sind unzulässig, wenn für ein Attribut eine Zeichenfolge erwartet wird. "" oder " " sind z. B. nicht zulässig.
Wenn das Attribut erforderlich ist, muss der Wert eine nicht leere Zeichenfolge sein. Wenn das Feld nicht erforderlich ist, solltest du das Schlüssel-Wert-Paar löschen.
body:
- type: input
attributes:
label: "Name"
Body[i]: id darf ausschließlich Zahlen, Buchstaben, -, _ enthalten
id-Attribute dürfen ausschließlich alphanumerische Zeichen, - und _ enthalten. Deine Vorlage umfasst möglicherweise unzulässige Zeichen (z. B. Leerzeichen) in einem id-Wert.
Bei Fehlern mit body wird das Präfix body[i] hinzugefügt, wobei i für den Index des Textblocks mit dem Fehler steht. body[0] weist z. B. darauf hin, dass der Fehler durch den ersten Block in der body-Liste verursacht wurde.
Beispiel für den Fehler „body[i]: id kann nur Zahlen, Buchstaben, - und _ enthalten“
name: "Bug report"
body:
- type: input
id: first name
attributes:
label: First name
Der Fehler kann behoben werden, indem sichergestellt wird, dass Leerzeichen und andere unzulässige Zeichen aus id-Werten entfernt werden.
name: "Bug report"
body:
- type: input
id: first-name
attributes:
label: First name
Body[i]: x ist kein zulässiger Schlüssel
Ein unerwarteter Schlüssel (x) wurde auf derselben Einzugsebene angegeben wie type und attributes.
Bei Fehlern mit body wird das Präfix body[i] hinzugefügt, wobei i für den Index des Textblocks mit dem Fehler steht. body[0] weist z. B. darauf hin, dass der Fehler durch den ersten Block in der body-Liste verursacht wurde.
Beispiel für den Fehler „body[i]: x ist kein zulässiger Schlüssel“
body:
- type: markdown
x: woof
attributes:
value: "Thanks for taking the time to fill out this bug! If you need real-time help, join us on Discord."
Der Fehler kann behoben werden, indem zusätzliche Schlüssel entfernt und lediglich type, attributes und id verwendet werden.
body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug! If you need real-time help, join us on Discord."
Body[i]: label enthält ein unzulässiges Wort
Damit das Risiko der Offenlegung privater Informationen und Anmeldeinformation in GitHub Issues verhindert wird, sind einige Wörter, die häufig von Angreifer*innen verwendet werden, in label-Werten von Eingabe- oder Textbereichselementen nicht zulässig.
Bei Fehlern mit body wird das Präfix body[i] hinzugefügt, wobei i für den Index des Textblocks mit dem Fehler steht. body[0] weist z. B. darauf hin, dass der Fehler durch den ersten Block in der body-Liste verursacht wurde.
Beispiel für den Fehler „body[i]: label enthält ein unzulässiges Wort“
body:
- type: markdown
attributes:
value: Hello world!
- type: input
attributes:
label: Password
Der Fehler kann behoben werden, indem Begriffe wie „password“ (Kennwort) aus label-Feldern entfernt werden.
body:
- type: markdown
attributes:
value: Hello world!
- type: input
attributes:
label: Username
Body[i]: x ist kein zulässiges Attribut
In einem attributes-Block wurde ein ungültiger Schlüssel angegeben.
Bei Fehlern mit body wird das Präfix body[i] hinzugefügt, wobei i für den Index des Textblocks mit dem Fehler steht. body[0] weist z. B. darauf hin, dass der Fehler durch den ersten Block in der body-Liste verursacht wurde.
Beispiel für den Fehler „body[i]: x ist kein zulässiges Attribut“
body:
- type: markdown
attributes:
x: "a random key!"
value: "Thanks for taking the time to fill out this bug!"
Der Fehler kann behoben werden, indem zusätzliche Schlüssel entfernt und lediglich zulässige Attribute verwendet werden.
body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug!"
Body[i]: options muss eindeutig sein
Die für Kontrollkästchen und Dropdowneingabetypen im options-Array definierten Auswahlmöglichkeiten müssen eindeutig sein.
Bei Fehlern mit body wird das Präfix body[i] hinzugefügt, wobei i für den Index des Textblocks mit dem Fehler steht. body[0] weist z. B. darauf hin, dass der Fehler durch den ersten Block in der body-Liste verursacht wurde.
Beispiel für den Fehler „body[i]: options muss eindeutig sein“
body:
- type: dropdown
attributes:
label: Favorite dessert
options:
- ice cream
- ice cream
- pie
Der Fehler kann behoben werden, indem sichergestellt wird, dass keine doppelten Auswahlmöglichkeiten im options-Array vorhanden sind.
body:
- type: dropdown
attributes:
label: Favorite dessert
options:
- ice cream
- pie
Body[i]: options darf das reservierte Wort „none“ (keine) nicht enthalten
„none“ (keine) ist ein reserviertes Wort in einer options-Auswahl, mit dem angezeigt wird, dass keine Auswahl getroffen wird, wenn kein dropdown-Wert erforderlich ist.
Bei Fehlern mit body wird das Präfix body[i] hinzugefügt, wobei i für den Index des Textblocks mit dem Fehler steht. body[0] weist z. B. darauf hin, dass der Fehler durch den ersten Block in der body-Liste verursacht wurde.
Beispiel für den Fehler „body[i]: options darf das reservierte Wort none nicht enthalten“
body:
- type: dropdown
attributes:
label: What types of pie do you like?
options:
- Steak & Ale
- Chicken & Leek
- None
validations:
required: true
Der Fehler kann behoben werden, indem „None“ (Keine) als Option entfernt wird. Wenn Mitwirkende angeben können sollen, dass sie keine dieser Optionen mögen, kannst du zusätzlich die required-Validierung entfernen.
body:
- type: dropdown
attributes:
label: What types of pie do you like?
options:
- Steak & Ale
- Chicken & Leek
In diesem Beispiel wird „None“ (Keine) automatisch als auswählbare Option gefüllt.
Body[i]: options darf keine booleschen Werte enthalten. Setze Werte wie „yes“ (ja) und „true“ (wahr) in Anführungszeichen.
Eine Reihe von englischen Wörtern werden vom YAML-Parser in boolesche Werte verarbeitet, wenn sie nicht in Anführungszeichen eingeschlossen sind. Bei Dropdownoptionen (options) müssen sämtliche Elemente Zeichenfolgen und keine booleschen Werte sein.
Bei Fehlern mit body wird das Präfix body[i] hinzugefügt, wobei i für den Index des Textblocks mit dem Fehler steht. body[0] weist z. B. darauf hin, dass der Fehler durch den ersten Block in der body-Liste verursacht wurde.
Beispiel für den Fehler „body[i]: options darf keine booleschen Werte enthalten. Werte wie „yes“ und „true“ müssen in Anführungszeichen eingeschlossen werden.“
body:
- type: dropdown
attributes:
label: Do you like pie?
options:
- Yes
- No
- Maybe
Der Fehler kann behoben werden, indem alle Optionen in Anführungszeichen gesetzt werden, bei denen Probleme aufgetreten sind. Auf diese Weise lässt sich verhindern, dass die Optionen als boolesche Werte verarbeitet werden.
body:
- type: dropdown
attributes:
label: Do you like pie?
options:
- "Yes"
- "No"
- Maybe
Text darf nicht leer sein
Das Vorlagentextpaar key:value darf nicht leer sein. Weitere Informationen dazu, welche Schlüssel oberster Ebene benötigt werden, findest du unter Syntax für Issueformulare.
Dieser Fehler kann durch Hinzufügen des Abschnitts body: behoben werden.
Beispiel für den Fehler „body kann nicht leer sein“
name: Support Request
description: Something went wrong and you need help?
---
body:
- type: textarea
attributes:
label: "What's wrong?"
In diesem Beispiel kann der Fehler durch Löschen des Abschnitts --- (Dokumenttrennzeichen) zwischen den Kopfzeilen und dem Abschnitt body behoben werden.
name: Support Request
description: Something went wrong and you need help?
body:
- type: textarea
attributes:
label: "What's wrong?"
Weiterführende Themen
- YAML
- Syntax for issue forms („Syntax für Issue-Formulare“)