3.3.2 Creando un template para tus PR (Pull Request)

Si quieres facilitar la revisión del PR y tener un mismo formato para todos los PR puedes crear un template con un checklist para los programadores y otro para los testers.

Crear un PR template

  1. Crea una carpeta .gitbub para mantenerlo como archivo oculto. Agrega un archivo llamado pullrequest_template.md. Si deseas diferentes templates, puedes crear 2 archivos dentro de la carpeta .github crea otra llamada PULL_REQUEST_TEMPLATE y agrega los siguientes archivos: - dev_pull_request_template.md: Para los PR de desarrollo - qa_pull_request_template.md: Para los PR para los testers

  2. Agrega el contenido, un ejemplo puede ser el siguiente:

dev_pull_request_template.md
## Descripción

<-- Agrega una descripción del user story !-->

## Resumen de los cambios

<-- Agrega una breve descripción de los cambios !-->

## Checklist

- [x] Compilación correcta
- [x] Documentación actualizada 
- [x] Se agregaron unit test
- [x] Unit test estan correctos

## Notas

<-- Agrega notas adicionales !-->

## Screensshots

Si solamente tienes un archivo para tus PR se mostrará automáticamente en cada Pull Request. Si tienes mas de un template debes agregar en la url el template que deseas ejemplo: https://github.com/apis3445/CaducaRest/compare/master...develop?quick_pull=1&template=dev_pull_request_template.md Para practicar puedes crear el PR para los testers y compararlo con mi solución en github.

Puedes ver la documentación oficial:

https://docs.github.com/es/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

Last updated