Skip to main content

Configurar las plantillas de reporte de problemas para tu repositorio

Puedes personalizar las plantillas disponibles para los colaboradores para que las utilicen cuando abren un nuevo reporte de problema en tu repositorio.

Puedes crear plantillas de incidencias predeterminadas y un archivo de configuración predeterminado para este tipo de plantillas para tu organización o cuenta personal. Para más información, vea "Creación de un archivo de estado de la comunidad predeterminado".

Crear plantillas de reporte de problemas

  1. On GitHub.com, navigate to the main page of the repository. 1. Debajo del nombre del repositorio, haz clic en Configuración. Botón de configuración del repositorio
  2. En la sección "Características", en "Incidencias", haga clic en Configurar plantillas. Botón para iniciar la configuración de plantillas
  3. Usa el menú desplegable Agregar plantilla y haz clic en el tipo de plantilla que deseas crear. Menú desplegable Agregar plantilla
  4. Para obtener una vista previa de la plantilla o editarla antes de confirmarla en el repositorio, haga clic en Vista previa y edición. Botón para mostrar la vista previa y editar
  5. Para editar la plantilla, haga clic en y escriba en los campos para editar el contenido. Botón Editar plantilla de incidencia
  6. Para establecer automáticamente un título predeterminado para la propuesta, asigna la propuesta a personas que tengan acceso de lectura al repositorio o aplica etiquetas a tu plantilla de propuesta e ingresa estos detalles en "Información adicional opcional". También puede agregar estos detalles en la plantilla de incidencia con title, labels o assignees en un texto preliminar de YAML. Información adicional de la plantilla de incidencia
  7. Cuando haya terminado de editar y ver la vista previa de la plantilla, haga clic en Proponer cambios en la esquina superior derecha de la página. Botón para proponer cambios
  8. Escribe un mensaje de confirmación que describa los cambios que realizaste. Campo de mensaje de confirmación de la plantilla de incidencia
  9. Debajo de los campos del mensaje de confirmación, decide si deseas confirmar tu plantilla directamente en la rama predeterminada o si deseas crear una nueva rama y abrir una solicitud de extracción. Para más información sobre las solicitudes de incorporación de cambios, vea "Acerca de las solicitudes de incorporación de cambios". Opción para confirmar la plantilla de incidencia en la rama principal o abrir una solicitud de incorporación de cambios
  10. Haga clic en Confirmar cambios. Una vez que estos cambios se fusionen en la rama predeterminada, la plantilla estará disponible para que la usen los colaboradores cuando abran nuevas propuestas en el repositorio.

Crear formatos de propuestas

Nota: Los formularios de incidencias se encuentran actualmente en versión beta solo para los repositorios públicos en GitHub.com.

Con los formatos de propuestas, puedes crear plantillas de propuestas que tengan campos de formato web personalizables. Puedes fomentar que los contribuyentes incluyan información específica y estructurada si utilizas formatos de propuestas en tu repositorio. Los formatos de propuesta se escriben en YAML utilizando el modelado de formatos de GitHub. Para más información, vea "Sintaxis del esquema de formulario para GitHub". Si no está familiarizado con YAML y quiere obtener más información, vea "Aprenda YAML en Y minutos".

Para usar un formulario de incidencia en el repositorio, debe crear un archivo y agregarlo a la carpeta .github/ISSUE_TEMPLATE del repositorio.

Aquí tienes un ejemplo de un archivo de confguración de un formato de propuesta.

YAML
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: true

Aquí está la versión interpretada de un formato de propuesta. Un formulario de incidencia representado

  1. Elige un repositorio en donde quieras crear un formato de propuesta. Puedes utilizar un repositorio existente al cual tengas acceso de escritura o puedes crear un repositorio nuevo. Para más información sobre cómo crear un repositorio, vea "Creación de un repositorio".
  2. En el repositorio, cree un archivo denominado .github/ISSUE_TEMPLATE/FORM-NAME.yml y reemplace FORM-NAME por el nombre del formulario de incidencia. Para más información sobre cómo crear archivos en GitHub, vea "Creación de archivos".
  3. En el campo del archivo nuevo, teclea el contenido de tu formato de propuesta. Para más información, vea "Sintaxis de los formularios de incidencia".
  4. Confirma tu archivo en la rama predeterminada de tu repositorio. Para más información, vea "Creación de archivos".

Configurar el selector de plantillas

Puede personalizar el selector de plantillas de incidencia que ven los usuarios al crear una incidencia en el repositorio si agrega un archivo config.yml a la carpeta .github/ISSUE_TEMPLATE.

Puede animar a los colaboradores a usar plantillas de incidencia si establece blank_issues_enabled en false. Si establece blank_issues_enabled en true, los usuarios tendrán la opción de abrir una incidencia en blanco.

Nota: Si ha usado el flujo de trabajo heredado para crear manualmente un archivo issue_template.md en la carpeta .github y habilita las incidencias en blanco en el archivo config.yml, se utilizará la plantilla de issue_template.md cuando los usuarios decidan abrir una incidencia en blanco. Si inhabilitas los reportes de problemas en blanco, la plantilla nunca se utilizará.

Si prefiere recibir determinados informes fuera de GitHub Enterprise Cloud, puede dirigir a los usuarios a sitios externos con contact_links.

Este es un archivo config.yml de ejemplo.

YAML
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.

Tu archivo de configuración personalizará el selector de plantilla cuando el archivo se combina en la rama predeterminada del repositorio.

  1. On GitHub.com, navigate to the main page of the repository. 1. Encima de la lista de archivos, haga clic en Create new file (Crear archivo) mediante la lista desplegable Add file (Agregar archivo). "Crear archivo" en la lista desplegable "Agregar archivo"
  2. En el campo del nombre de archivo, escriba .github/ISSUE_TEMPLATE/config.yml. Nombre de archivo de configuración
  3. Teclea el contenido de tu archivo de configuración en el cuerpo del nuevo archivo. Contenido del archivo de configuración 1. En la parte inferior de la página, teclea un mensaje de confirmación corto y significativo que describa el cambio que realizaste al archivo. Puedes atribuir el cambio a mas de un autor en el mensaje del mismo. Para más información, vea "Creación de una confirmación con varios coautores". Mensaje de confirmación para el cambio 1. Debajo de los campos para el mensaje de confirmación, decide si deseas agregar tu confirmación a la rama actual o a una rama nueva. Debajo de los campos del mensaje de confirmación, decide si deseas agregar tu confirmación a la rama actual o a una nueva rama. Si tu rama actual es la rama predeterminada, debes elegir crear una nueva rama para tu confirmación y después crear una solicitud de extracción. Para más información, vea "Creación de una solicitud de incorporación de cambios". Opciones de confirmación de rama 1. Haga clic en Proponer nuevo archivo. Botón para proponer un nuevo archivo

Información adicional