Crear de forma manual una plantilla de propuesta para tu repositorio

Cuando agregas una plantilla de propuesta creada de forma manual a tu repositorio, los colaboradores del proyecto verán automáticamente los contenidos de la plantilla en el cuerpo de la propuesta.

En este artículo

Warning

Este es el flujo de trabajo tradicional para crear una plantilla de informe de problemas. Te recomendamos utilizar el constructor de plantillas de propuesta múltiples mejorado o emitir formatos para crear plantillas de propuestas. Para obtener más información, vea «Acerca de las plantillas de propuestas y solicitudes de extracción».

Puede crear un subdirectorio de ISSUE_TEMPLATE/ en cualquiera de las carpetas admitidas para incluir múltiples plantillas de incidencia y usar el parámetro de consulta template para especificar la plantilla que rellenará el cuerpo de la incidencia. Para más información, consulta Crear una propuesta.

Puede añadir texto preliminar de YAML a cada plantilla de reporte de problemas para pre-llenar el título del mismo, añadir etiquetas y personal asignado automáticamente, y asignar un nombre y descripción que se mostrará en el selector de la misma, el cual verán las personas cuando se cree un nuevo reporte de problemas en su repositorio.

Aquí hay un ejemplo de texto preliminar de YAML.

---
name: Tracking issue
about: Use this template for tracking new features.
title: "[DATE]: [FEATURE NAME]"
labels: tracking issue, needs triage
assignees: octocat
---

Note

Si un valor del texto preliminar incluye algún carácter reservado por YAML, como :, tendrás que incluir ese valor entre comillas. Por ejemplo, ":bug: Bug" o ":new: triage needed, :bug: bug".

Para que se muestren con una marca en la lista de comprobación del perfil de la comunidad, las plantillas de incidencia deben estar en la carpeta .github/ISSUE_TEMPLATE y contener claves name: y about: válidas en el texto preliminar de TAML (en el caso de plantillas de incidencia definidas en archivos .md) o claves name: y description: válidas (en el caso de formularios de incidencia definidos en archivos .yml).

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 obtener más información, vea «Creación de un archivo predeterminado de mantenimiento de la comunidad».

Agregar una plantilla de propuesta

  1. En GitHub, navegue hasta la página principal del repositorio.

  2. Encima de la lista de archivos, selecciona el menú desplegable Add file y, a continuación, haz clic en Create new file.

    Como alternativa, puedes hacer clic en en la vista de árbol de archivos a la izquierda.

    Captura de pantalla de la página principal de un repositorio. Encima de la lista de archivos, un botón con la etiqueta "Agregar archivo", aparece resaltado en naranja oscuro. En la vista de árbol de archivos del repositorio, un botón con el icono de signo más, también aparece resaltado en naranja oscuro.

  3. En el campo para el nombre del archivo:

    • Para que la plantilla de incidencia sea visible en el directorio raíz del repositorio, escriba el nombre de la plantilla_de_incidencia. Por ejemplo, issue_template.md.
    • Para que la plantilla de incidencia sea visible en el directorio docs del repositorio, escriba docs/ seguido del nombre de la plantilla_de_incidencia. Por ejemplo, docs/issue_template.md.
    • Para almacenar el archivo en un directorio oculto, escriba .github/ seguido del nombre de la plantilla_de_incidencia. Por ejemplo, .github/issue_template.md.
    • Para crear varias plantillas de incidencia y usar el parámetro de consulta template a fin de especificar una plantilla para rellenar el cuerpo de la incidencia, escriba .github/PLANTILLA_DE_INCIDENCIA/ y después el nombre de la plantilla de incidencia. Por ejemplo, .github/ISSUE_TEMPLATE/issue_template.md. También puede almacenar varias plantillas de incidencia en un subdirectorio ISSUE_TEMPLATE dentro de los directorios raíz o docs/. Para más información, consulta Crear una propuesta.

  4. En el cuerpo del nuevo archivo, agrega tu plantilla de propuesta. Puede incluir:

    • Texto preliminar de YAML
    • Comportamiento esperado y comportamiento real
    • Pasos para reproducir el problema
    • Especificaciones como la versión del proyecto, el sistema operativo o el hardware

  5. Haz clic en Confirmar cambios... .

  6. En el campo de "Mensaje de confirmación", escriba un mensaje de confirmación corto y significativo que describa la modificación que hizo en el archivo. Puedes atribuir el cambio a mas de un autor en el mensaje del mismo. Para obtener más información, vea «Crear una confirmación con distintos autores».

  7. 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 obtener más información, vea «Crear una solicitud de incorporación de cambios».

    Captura de pantalla de una solicitud de cambios de GitHub en la que se muestra un botón de radio para confirmar directamente en la rama principal o para crear una nueva rama. Aparece seleccionada la opción de rama nueva.
    Las plantillas están disponibles para los colaboradores cuando se combinan dentro de la rama predeterminada del repositorio.

  8. Haz clic en Confirmar cambios o Proponer cambios.

Información adicional