Sintaxis para formularios de incidencias

Puedes definir diferentes tipos de entrada, validaciones, asingados predeterminados y etiquetas predeterminadas para tus formatos de propuesta.

En este artículo

Note

Los formularios de propuesta se encuentran actualmente en versión preliminar pública y están sujeto a cambios.

Acerca de la sintaxis YAML para formatos de propuesta

Puede crear formatos de incidencia personalizados si agrega un archivo de definición de formato YAML a la carpeta /.github/ISSUE_TEMPLATE del repositorio. Si no está familiarizado con YAML y quiere obtener más información, vea "Aprenda YAML en Y minutos". Puedes definir diferentes tipos de entrada, validaciones, asingados predeterminados y etiquetas predeterminadas para tus formatos de propuesta.

Cuando un colaborador llega un formato de propuesta, sus respuestas para cada entrada se convierten en lenguaje de marcado y se agregan al cuerpo de una propuesta. Los contribuyentes pueden editar las propuestas que se crearon con estos formatos de propuesta y otras personas pueden interactuar con las propuestas como con una de ellas que se creó mediante otros métodos.

Los formatos de propuesta no son compatibles para las solicitudes de cambios. Puedes crear plantillas de solicitudes de cambios en tus repositorios para que las utilicen los colaboradores. Para más información, consulta Crear una plantilla de solicitud de extracción para tu repositorio.

Este archivo de configuración YAML define un formato de propuesta utilizando varias entradas para reportar un error.

Note

La clave de campo required solo se admite en repositorios públicos. En repositorios privados e internos, todos los campos son opcionales.

YAML
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: ["bug", "triage"]
projects: ["octo-org/1", "octo-org/44"]
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)
      default: 0
    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

Sintaxis de nivel superior

Todos los archivos de configuración del formulario de incidencias deben comenzar con pares clave-valor name, description y body.

YAML
name:
description:
body:

Puedes configurar las siguientes llaves de nivel superior para cada formato de propuesta.

ClaveDescripciónObligatorioTipo
nameUn nombre para la plantilla de formato de propuesta. Debe ser único entre el resto de las plantillas, incluyendo de las plantillas de lenguaje de marcado.ObligatorioString
descriptionUna descripción para la plantilla de formato de propuesta, la cual aparece en la interfaz de elección de plantilla.ObligatorioString
bodyDefinición de los tipos de entrada en el formato.ObligatorioArray
assigneesLas personas que se asignarán automáticamente a las propuestas que se crearán con esta plantilla.OpcionalesArreglo o secuencia delimitada por comas
labelsLas etiquetas que se agregarán automáticamente a las propuestas que se crearán con esta plantilla. Si todavía no hay ninguna etiqueta en el repositorio, no se agregará automáticamente a la incidencia.OpcionalesArreglo o secuencia delimitada por comas
titleUn título predeterminado que se pre-llenará en el formato de emisión de propuestas.OpcionalesString
projectsProyectos a los que se añadirá automáticamente cualquier incidencia creada con esta plantilla. El formato de esta clave es PROJECT-OWNER/PROJECT-NUMBER. > [!NOTE] La persona que abre el problema debe tener permisos de escritura para los proyectos especificados. Si no desea que los usuarios que usen esta plantilla tengan acceso de escritura, considere la posibilidad de habilitar el flujo de trabajo de adición automática del proyecto. Para más información, consulta Incorporación automática de artículos.OpcionalesArreglo o secuencia delimitada por comas

Para conocer los tipos de entrada body disponibles y su sintaxis, consulta Sintaxis para el modelado de formato de GitHub.

Convertir una plantilla de propuesta de lenguaje de marcado en una plantilla de formato de propuesta YAML

Puedes utilizar plantillas de propuestas tanto de YAML como de lenguaje de marcado en tu repositorio. Si quieres convertir una plantilla de propuesta con lenguaje de marcado en una plantilla de formato de propuesta YAML, debes crear un archivo YAML nuevo para definir el formato de la propuesta. Puedes transponer manualmente una plantilla de propuesta de lenguaje de marcado hacia un formato de propuesta YAML. Para más información, consulta Configurar las plantillas de reporte de problemas para tu repositorio.

Si quieres utilizar el mismo nombre de archivo para tu formato de propuesta YAML, debes borrar la plantilla de propuesta en lenguaje de marcado cuando confirmes el archivo nuevo en tu repositorio.

A continuación podrás encontrar un ejemplo de plantilla de propuesta de lenguaje de marcado y una plantilla de formato de propuesta YAML correspondiente.

Plantilla de propuesta de lenguaje de marcado

Markdown
---
name: 🐞 Bug
about: File a bug/issue
title: '[BUG] <title>'
labels: Bug, Needs Triage
assignees: ''

---

<!--
Note: Please search to see if an issue already exists for the bug you encountered.
-->

### Current Behavior:
<!-- A concise description of what you're experiencing. -->

### Expected Behavior:
<!-- A concise description of what you expected to happen. -->

### Steps To Reproduce:
<!--
Example: steps to reproduce the behavior:
1. In this environment...
1. With this config...
1. Run '...'
1. See error...
-->

### Environment:
<!--
Example:
- OS: Ubuntu 20.04
- Node: 13.14.0
- npm: 7.6.3
-->

### Anything else:
<!--
Links? References? Anything that will give us more context about the issue that you are encountering!
-->

Plantilla de formato de propuesta YAML

YAML
name: 🐞 Bug
description: File a bug/issue
title: "[BUG] <title>"
labels: ["Bug", "Needs Triage"]
body:
- type: checkboxes
  attributes:
    label: Is there an existing issue for this?
    description: Please search to see if an issue already exists for the bug you encountered.
    options:
    - label: I have searched the existing issues
      required: true
- type: textarea
  attributes:
    label: Current Behavior
    description: A concise description of what you're experiencing.
  validations:
    required: false
- type: textarea
  attributes:
    label: Expected Behavior
    description: A concise description of what you expected to happen.
  validations:
    required: false
- type: textarea
  attributes:
    label: Steps To Reproduce
    description: Steps to reproduce the behavior.
    placeholder: |
      1. In this environment...
      1. With this config...
      1. Run '...'
      1. See error...
  validations:
    required: false
- type: textarea
  attributes:
    label: Environment
    description: |
      examples:
        - **OS**: Ubuntu 20.04
        - **Node**: 13.14.0
        - **npm**: 7.6.3
    value: |
        - OS:
        - Node:
        - npm:
    render: markdown
  validations:
    required: false
- type: textarea
  attributes:
    label: Anything else?
    description: |
      Links? References? Anything that will give us more context about the issue you are encountering!

      Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
  validations:
    required: false

Información adicional