Cómo crear una plantilla de Pull Request en GitHub
Tener una plantilla de Pull Request es una forma muy útil de estandarizar la forma de hacer PRs en los proyectos en los que trabajas. En Calima usamos una PR parecida a esta:
## ¿Qué se ha hecho en esta PR?
Incluye un resumen del cambio y el problema que se ha solucionado. Incluye también la motivación y el contexto necesarios. Enumera las dependencias necesarias para este cambio.
Arregla: *Indica aquí si arregla algún issue de JIRA*
## Tipo de cambio
Elimina las opciones no relevantes:
[x] Bug fix (non-breaking change que arregla un bug)
[x] Nueva funcionalidad (non-breaking change que añade funcionalidad)
[x] Breaking change (fix o feature que causaría un cambio en una funcionalidad ya existente)
[x] Este cambio requiere actualizar la documentación
## ¿Has hecho tests automáticos?
[ ] Sí
[ ] No
## ¿Cuál es el comportamiento esperado tras el cambio? Por favor, especifica el enlace a Figma si es necesario.
## ¿Cómo se pueden testear las características introducidas en esta PR?
## Añade el link del issue en JIRA si lo hubiera
Especialmente cuando trabajas en un equipo esto proporciona una información muy importante, ya que le da al reviewer toda la información que necesita para poder revisar el código y su funcionalidad. Afortunadamente, GitHub nos da una forma muy sencilla de preparar este template en nuestros repositorios:
Cómo configurar una plantilla de PR en un repositorio de GitHub
Es realmente simple. Para crear la plantilla, solo tenemos que crear un fichero llamado pull_request_template.md
en la raíz de nuestro repositorio:
Una vez hecho esto, solo hay que pushear los cambios y las próximas PRs ya tendrán esta plantilla lista para rellenar.