Una vez que creas las plantillas de propuestas y solicitudes de extracción en tu repositorio, los colaboradores pueden usar las plantillas para abrir propuestas o describir los cambios propuestos en sus solicitudes de extracción de acuerdo con las pautas de contribución del repositorio. Para más información sobre cómo agregar directrices de contribución a un repositorio, consulta Configurar pautas para los colaboradores de repositorios.
Puedes crear plantillas predeterminadas de incidencias y solicitudes de incorporación de cambios para tu cuenta personal o de la organización. Para más información, consulta Creación de un archivo predeterminado de mantenimiento de la comunidad.
Plantillas de propuestas
Al crear plantillas de problemas para el repositorio mediante el generador de plantillas de problemas o con formularios de problemas, los colaboradores pueden seleccionar la plantilla adecuada cuando abran nuevos problemas en el repositorio.
El emitir plantillas es útil cuando quieres proporcionar lineamientos para las propuestas que se abren mientras que permites que los contribuyentes especifiquen el contenido de sus propuestas. Si quieres que los colaboradores proporcionen información específica y estructurada cuando abran problemas, los formularios de problemas permiten garantizar que recibes la información deseada.
Al usar el creador de plantillas, puedes especificar un título y una descripción para cada plantilla, agregar el contenido de la plantilla y asignar la plantilla a la rama por defecto o bien abrir una solicitud de extracción en el repositorio. El creador de plantillas automáticamente agrega el markup del texto preliminar de YAML que se requiere para que la plantilla aparezca en la página de la propuesta nueva. Para más información, consulta Configurar las plantillas de reporte de problemas para tu repositorio.
Con los formularios de problemas, puedes crear plantillas que tengan campos de formulario web mediante el esquema de formulario GitHub. Cuando un contribuyente abre una propuesta utilizando un formato de propuesta, las entradas de este formato se convierten en un comentario de propuesta con lenguaje de marcado estándar. Puedes especificar varios tipos diferentes de entradas y configurarlas como se requieran para ayudar a que los contribuyentes abran las propuestas accionables en tu repositorio. Para más información, consulta Configurar las plantillas de reporte de problemas para tu repositorio y Sintaxis para formularios de incidencias.
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. Para más información, consulta Configurar las plantillas de reporte de problemas para tu repositorio.
Las plantillas de problemas se almacenan en la rama predeterminada del repositorio, en un directorio oculto .github/ISSUE_TEMPLATE. Si creas una plantilla en otra rama, no estará disponible para que la usen los colaboradores. Los nombres de archivo de las plantillas de propuestas no distinguen entre mayúsculas y minúsculas y necesitan tener una extensión .md.Las plantillas de propuestas que se crearon con formatos de propuesta necesitan una extensión .yml. 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).
Es posible crear de forma manual una única plantilla de propuesta en Markdown usando el flujo de trabajo de la plantilla de propuesta heredado. Los colaboradores del proyecto automáticamente ven el contenido de la plantilla en el cuerpo de la propuesta. Pero se recomienda usar el generador de plantillas de varios problemas actualizado o el formulario de problemas para crear plantillas de problemas. Para más información sobre el flujo de trabajo heredado, consulta Crear de forma manual una plantilla de propuesta para tu repositorio.
Puedes crear una política de seguridad para dar instrucciones a las personas para reportar las vulnerabilidades de seguridad en tu proyecto. Para obtener más información, vea «Agregar una política de seguridad a tu repositorio».
Plantillas de solicitud de incorporación de cambios
Cuando agregas una plantilla de solicitud de extracción a tu repositorio, los colaboradores del proyecto verán automáticamente los contenidos de la plantilla en el cuerpo de la solicitud de extracción.
Debes crear las plantillas en la rama por defecto del repositorio. Las plantillas creadas en otras ramas no están disponibles para que las usen los colaboradores. Puede almacenar su plantilla de solicitud de incorporación de cambios en el directorio raíz visible del repositorio, la carpeta docs o el directorio .github oculto. Los nombres de archivo de la plantilla de solicitud de incorporación de cambios no distinguen entre mayúsculas y minúsculas y pueden tener una extensión como .md o .txt.
Para más información, consulta Crear una plantilla de solicitud de extracción para tu repositorio.