Note: Issue forms are currently in beta for public repositories on GitHub.com only.
O nome
da chave de nível superior exigido está ausente
O modelo não contém um campo nome
, o que significa que não está claro que nome dar ao seu modelo de problema ao fornecer aos usuários uma lista de opções.
Exemplo
descrição: "Obrigado por relatar um erro!"
...
O erro pode ser corrigido adicionando nome
como chave.
name: "Bug report"
description: "Thank you for reporting a bug!"
...
a chave
deve ser uma string
Esta mensagem de erro significa que uma chave permitida foi fornecida, mas seu valor não pode ser analisado porque o tipo de dado não é compatível.
Exemplo
A descrição
abaixo está sendo analisada como um booleano, mas deve ser uma string.
name: "Bug report"
description: true
...
O erro pode ser corrigido fornecendo uma string como o valor. As strings podem ter de ser envolvidas em aspas duplas para serem analisadas com sucesso. Por exemplo, as strings que contenham '
devem estar entre aspas duplas.
name: "Bug report"
description: "true"
...
As strings vazias ou que consistem em espaços em branco também não são permitidas quando o campo espera uma string.
name: ""
description: "File a bug report"
assignees: " "
...
O erro pode ser corrigido ajustando o valor como uma string não vazia. Se o campo não for obrigatório, você deverá excluir o par chave-valor.
name: "Bug Report"
description: "File a bug report"
...
entrada
não é uma chave permitida
Uma chave inesperada foi fornecida no nível superior do modelo. Para obter mais informações sobre quais chaves de nível superior são compatíveis, consulte "Sintaxe para os formulários do problema. "
Exemplo
name: "Bug report"
hello: world
...
O erro pode ser corrigido removendo as chaves inesperadas.
name: "Bug report"
...
Chaves proibidas
O YAML analisa certas strings como valores booleanos
. Para evitar isso, proibimos explicitamente o uso das seguintes chaves:
y
, Y
, yes
, Yes
, YES
, n
, N
, no
, No
, NO
, true
, True
, TRUE
, false
, False
, FALSE
, on
, On
, ON
, off
, Off
, OFF
O erro pode ser corrigido removendo as chaves proibidas.
O texto deve conter pelo menos um campo que não seja markdown
Os formulários de problemas devem aceitar a entrada do usuário, o que significa que pelo menos um dos seus campos deve conter um campo de entrada de usuário. Um elemento markdown
é um texto estático. Portanto, uma matriz do texto
não pode conter apenas elementos de markdown
.
Exemplo
name: "Bug report"
body:
- type: markdown
attributes:
value: "Bugs are the worst!"
O erro pode ser corrigido adicionando elementos que não são markdown que aceitam a entrada do usuário.
name: "Bug report"
body:
- type: markdown
attributes:
value: "Bugs are the worst!"
- type: textarea
attributes:
label: "What's wrong?"
O texto deve ter identificações únicas
Se você estiver usando atributos de id
para distinguir vários elementos, cada atributo de id
deverá ser único.
Exemplo
name: "Bug report"
body:
- type: input
id: name
attributes:
label: First name
- type: input
id: name
attributes:
label: Last name
O erro pode ser corrigido alterando o id
para uma dessas entradas, para que todo campo entrada
tenha um atributo id
único.
name: "Bug report"
body:
- type: input
id: name
attributes:
label: First name
- type: input
id: surname
attributes:
label: Last name
O texto deve ter etiquetas únicas
Quando há vários elementos do texto
que aceitam entrada do usuário, o atributo etiqueta
para cada campo de entrada do usuário deve ser único.
Exemplo
name: "Bug report"
body:
- type: textarea
attributes:
label: Name
- type: textarea
attributes:
label: Name
O erro pode ser corrigido alterando o atributo rótulo
para um dos campos de entrada para garantir que cada etiqueta
seja única.
name: "Bug report"
body:
- type: textarea
attributes:
label: Name
- type: textarea
attributes:
label: Operating System
Os campos de entrada também podem ser diferenciados pelo seu atributo id
. Se forem necessários atributos de etiquetas
duplicadas, você poderá fornecer pelo menos um id
para diferenciar dois elementos com etiquetas idênticas.
name: "Bug report"
body:
- type: textarea
id: name_1
attributes:
label: Name
- type: textarea
id: name_2
attributes:
label: Name
Os atributos de id
não estão visíveis no texto do problema. Se você deseja distinguir os campos do problema resultante, você deverá usar atributos da etiqueta
distintos.
As etiquetas são muito semelhantes
As etiquetas semelhantes podem ser processadas em referências idênticas. Se um atributo de id
não é fornecido para uma entrada
, o atributo etiqueta
será usado para gerar uma referência ao campo entrada
de entrada. Para fazer isso, processamos a etiqueta `` usando o método de parametrização do Rails. Em alguns casos, duas etiquetas distintas podem ser processadas dentro da mesma string parametrizada.
Exemplo
name: "Bug report"
body:
- type: input
attributes:
label: Name?
- type: input
id: name
attributes:
label: Name???????
O erro pode ser corrigido adicionando pelo menos um caractere alfanumérico diferenciando, -
ou _
para uma das etiquetas em conflito.
name: "Bug report"
body:
- type: input
attributes:
label: Name?
- type: input
attributes:
label: Your name
O erro também pode ser corrigido dando a uma das etiquetas em conflito um único id
.
name: "Bug report"
body:
- type: input
attributes:
label: Name?
- type: input
id: your-name
attributes:
label: Name???????
As caixas de seleção devem ter etiquetas únicas
Quando um elemento das caixas de seleção
está presente, cada uma das etiquetas aninhadas deve ser única entre seus pares, bem como entre os outros tipos de entrada.
Exemplo
name: "Bug report"
body:
- type: textarea
attributes:
label: Name
- type: checkboxes
attributes:
options:
- label: Name
O erro pode ser corrigido alterando o atributo etiqueta
para uma destas entradas.
name: "Bug report"
body:
- type: textarea
attributes:
label: Name
- type: checkboxes
attributes:
options:
- label: Your name
Como alternativa, você pode fornecer um id
para qualquer conflito de elementos de nível superior. Elementos de caixa de seleção aninhada não são compatíveis com o atributo id
.
name: "Bug report"
body:
- type: textarea
id: name_1
attributes:
label: Name
- type: checkboxes
attributes:
options:
- label: Name
Os atributos de id
não estão visíveis no texto do problema. Se você deseja distinguir os campos do problema resultante, você deverá usar atributos da etiqueta
distintos.
Body[i]: o tipo de chave necessário está ausente
Cada bloco de texto deve conter a chave tipo
.
Os erros com texto
serão prefixados com body[i]
, em que i
representa o índice indexado a zero do bloco do texto que contém o erro. Por exemplo, body[0]
nos diz que o erro foi causado pelo primeiro bloco na lista texto
.
Exemplo
body:
- attributes:
value: "Thanks for taking the time to fill out this bug! Se precisar de ajuda em tempo real, junte-se a nós no Discord."
O erro pode ser corrigido adicionando a chave tipo
a um tipo de entrada válido como valor. Para os tipos de entrada disponíveis texto
e suas sintaxes, consulte "Sintaxe para o esquema de formulário GitHub".
body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug! Se precisar de ajuda em tempo real, junte-se a nós no Discord."
Body[i]: x
não é um tipo de entrada válido
Um dos blocos do texto contém um valor de tipo que não é um dos tipos permitidos.
Os erros com texto
serão prefixados com body[i]
, em que i
representa o índice do bloco do texto que contém o erro. Por exemplo, body[0]
nos diz que o erro foi causado pelo primeiro bloco na lista texto
.
Exemplo
body:
- type: x
attributes:
value: "Thanks for taking the time to fill out this bug! Se precisar de ajuda em tempo real, junte-se a nós no Discord."
O erro pode ser corrigido alterando x
para um dos tipos válidos.
body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug! Se precisar de ajuda em tempo real, junte-se a nós no Discord."
Body[i]: a chave do atributo valor
necessário está ausente
Um dos atributos de valor
necessários não foi fornecido. O erro ocorre quando um bloco não tem uma chave de atributo
ou não tem uma chave de valor
na chave atributos
.
Os erros com texto
serão prefixados com body[i]
, em que i
representa o índice do bloco do texto que contém o erro. Por exemplo, body[0]
nos diz que o erro foi causado pelo primeiro bloco na lista texto
.
Exemplo
body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug! Se precisar de ajuda em tempo real, junte-se a nós no Discord."
- type: markdown
O erro neste exemplo pode ser corrigido adicionando valor
como uma chave abaixo de atributos
no segundo elemento da lista do texto
.
body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug! Se precisar de ajuda em tempo real, junte-se a nós no Discord."
- type: markdown
attributes:
value: "This is working now!"
Body[i]: a etiqueta deve ser uma string
Dentro dos seus blocos de atributos
, um valor tem o tipo de dado incorreto.
Os erros com texto
serão prefixados com body[i]
, em que i
representa o índice do bloco do texto que contém o erro. Por exemplo, body[0]
nos diz que o erro foi causado pelo primeiro bloco na lista texto
.
Exemplo
A etiqueta
abaixo está sendo analisada como um booleano, mas deve ser uma string.
body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug! Se precisar de ajuda em tempo real, junte-se a nós no Discord."
- type: textarea
attributes:
label: Bug Description
- type: textarea
attributes:
label: true
O erro pode ser corrigido fornecendo um valor string para a etiqueta
. Se você quiser usar um valor da etiqueta
que pode ser analisado como um valor booleano, número inteiro, ou decimal, você deverá colocar o valor entre aspas. Por exemplo, "verdadeiro"
ou "1.3"
em vez de verdadeiro
ou 1.3
.
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug! Se precisar de ajuda em tempo real, junte-se a nós no Discord."
- type: textarea
attributes:
label: Bug Description
- type: textarea
attributes:
label: Environment Details
As strings vazias ou strings que consistem em apenas espaços em branco não são permitidas quando um atributo espera uma string. Por exemplo, ""
ou " "
não são permitidos.
Se o atributo é obrigatório, o valor deverá ser uma string não vazia. Se o campo não for obrigatório, você deverá excluir o par chave-valor.
body:
- type: input
attributes:
label: "Name"
Body[i]: id
pode apenas conter números, letras, -, _
Atributos de id
podem conter apenas caracteres alfanuméricos, -
, e _
. Seu modelo pode incluir caracteres não permitidos, como espaços em branco, em um id
.
Os erros com texto
serão prefixados com body[i]
, em que i
representa o índice do bloco do texto que contém o erro. Por exemplo, body[0]
nos diz que o erro foi causado pelo primeiro bloco na lista texto
.
Exemplo
name: "Bug report"
body:
- type: input
id: first name
attributes:
label: First name
O erro pode ser corrigido garantindo que os espaços em branco e outros caracteres não permitidos sejam removidos de valores da id
.
name: "Bug report"
body:
- type: input
id: first-name
attributes:
label: First name
Body[i]: x
não é uma chave permitida
Uma chave inesperada, x
, foi fornecida no mesmo nível de indentação que tipo
e atributos
.
Os erros com texto
serão prefixados com body[i]
, em que i
representa o índice do bloco do texto que contém o erro. Por exemplo, body[0]
nos diz que o erro foi causado pelo primeiro bloco na lista texto
.
Exemplo
body:
- type: markdown
x: woof
attributes:
value: "Thanks for taking the time to fill out this bug! Se precisar de ajuda em tempo real, junte-se a nós no Discord."
O erro pode ser corrigido removendo chaves extras e usando apenas tipo
, atributos
e id
.
body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug! Se precisar de ajuda em tempo real, junte-se a nós no Discord."
Body[i]: label
contém a palavra proibida
Para minimizar o risco de informações e credenciais privadas serem publicadas nos problemas do GitHub, algumas palavras comumente usadas por invasores não são permitidas na etiqueta
de entrada ou elementos de texto.
Os erros com texto
serão prefixados com body[i]
, em que i
representa o índice do bloco do texto que contém o erro. Por exemplo, body[0]
nos diz que o erro foi causado pelo primeiro bloco na lista texto
.
Exemplo
body:
- type: markdown
attributes:
value: Hello world!
- type: input
attributes:
label: Password
O erro pode ser corrigido removendo termos como "senha" de qualquer campo da etiqueta
.
body:
- type: markdown
attributes:
value: Hello world!
- type: input
attributes:
label: Username
Body[i]: x
não é um atributo permitido
Uma chave inválida foi fornecida em um bloco de atributos
.
Os erros com texto
serão prefixados com body[i]
, em que i
representa o índice do bloco do texto que contém o erro. Por exemplo, body[0]
nos diz que o erro foi causado pelo primeiro bloco na lista texto
.
Exemplo
body:
- type: markdown
attributes:
x: "a random key!"
valor: "Obrigado por reservar um tempo tempo para preencher esse erro!"
O erro pode ser corrigido removendo chaves extras e usando apenas os atributos permitidos.
body:
- type: markdown
attributes:
value: "Thanks for taking the time to fill out this bug!"
Body[i]: opções
devem ser únicas
Para caixas de seleção e tipos de entrada de menu suspenso, as escolhas definidas na matriz opções
devem ser únicas.
Os erros com texto
serão prefixados com body[i]
, em que i
representa o índice do bloco do texto que contém o erro. Por exemplo, body[0]
nos diz que o erro foi causado pelo primeiro bloco na lista texto
.
Exemplo
body:
- type: dropdown
attributes:
label: Favorite dessert
options:
- ice cream
- ice cream
- pie
O erro pode ser corrigido garantindo que não existam opções duplicadas na matriz de opções
.
body:
- type: dropdown
attributes:
label: Favorite dessert
options:
- ice cream
- pie
Body[i]: options
não deve incluir a palavra reservada, nenhum
"Nenhum" é uma palavra reservada em um conjunto de opções
porque é usado para indicar a não escolha quando não um dropdown
não é necessário.
Os erros com texto
serão prefixados com body[i]
, em que i
representa o índice do bloco do texto que contém o erro. Por exemplo, body[0]
nos diz que o erro foi causado pelo primeiro bloco na lista texto
.
Exemplo
body:
- type: dropdown
attributes:
label: What types of pie do you like?
options:
- Steak & Ale
- Chicken & Leek
- None
validations:
required: true
O erro pode ser corrigido removendo "Nenhum" como opção. Se você deseja que um contribuidor possa indicar que ele não gosta de nenhum desses tipos de tortas, você pode também remover a validação necessária
.
body:
- type: dropdown
attributes:
label: What types of pie do you like?
options:
- Steak & Ale
- Chicken & Leek
Neste exemplo, "Nenhum" será preenchido automaticamente como uma opção selecionável.
Body[i]: options
não deve incluir booleanos. Por favor, coloque os valores como "sim" e "verdadeiro" entre aspas
Há uma série de palavras em inglês processadas em valores booleanos pelo analisador do YAML, a menos que sejam entre aspas. Para as opções
do menu suspenso, todos os itens devem ser strings ao invés de booleanos.
Os erros com texto
serão prefixados com body[i]
, em que i
representa o índice do bloco do texto que contém o erro. Por exemplo, body[0]
nos diz que o erro foi causado pelo primeiro bloco na lista texto
.
Exemplo
body:
- type: dropdown
attributes:
label: Do you like pie?
options:
- Yes
- No
- Maybe
O erro pode ser corrigido colocando cada opção incorreta entre aspas, para evitar que sejam processados como valores booleanos.
body:
- type: dropdown
attributes:
label: Do you like pie?
options:
- "Yes"
- "No"
- Maybe