Mejorando la productividad en nuestros Pull Request de Azure Repos

Hay veces que nos puede tocar revisar varios Pull Request (PR) y dependiendo del tamaño del equipo cada PR puede variar según quién lo crea. O también nos toca a nosotros crear un PR y tratamos de ser lo más descriptivo posible a nuestra manera. Y es común que en la descripción nos encontremos con una lista de los commits realizados (incluyendo aquellos que son propios de git al hacer un merge), no cabe duda de que al encontrarnos con algo así es muy probable que pasemos por alto leer cada uno de esos commits.

¿Por qué no mejor alinearnos con el equipo y definir una estructura más legible de nuestro PR? 😃

Con Azure Repos podemos crear 3 tipos de plantillas (templates) para la descripción de nuestros PR.

1. Una plantilla por defecto para todos los PR
2. Una plantilla para una rama específica
3. Una plantilla adicional, que se puede agregar a otras plantillas

¿Cómo creo mi primera plantilla para Pull Request en Azure Repos?

Lo primero que debemos que hacer es crear una carpeta base en la raíz de nuestro repositorio. Esta carpeta tiene que tener alguno de estos nombres:

• .azuredevops

• .vsts

• docs

La carpeta de la plantilla debe crearse en la rama predeterminada (default) del repositorio

Plantilla por defecto

Dentro de nuestra carpeta base debemos crear un archivo con el nombre:

• pull_request_template.md

La plantilla puede ser construida en texto planlo (.txt) ó lenguaje Markdown (.md). La ventaja de que sea .md (markdown) es que podemos dar estilos a nuestra descripción como por ejemplo:

Una vez creada la carpeta y el archivo, sólo resta incorporar los cambios a la rama predeterminada. Ya sea con un git push, git merge o un PR. Luego cada vez que se cree un PR veremos nuestra plantilla en la descripción.

Plantilla para una rama específica

Si queremos tener una plantilla particular para una o más ramas podemos hacerlo facílmente de la siguiente manera.

En nuestra carpeta base debemos agregarle dos carpetas más:

• carpeta base/pull_request_template/branches/

Y dentro de la carpeta branches agregar los archivos de nuestras ramas. Por ejemplo:

• carpeta base/pull_request_template/branches/main.md
• carpeta base/pull_request_template/branches/dev.md
• carpeta base/pull_request_template/branches/feature.md

Esto hará que la plantilla aplique para toda rama con el nombre del archivo incluso para las ramas en carpetas, por ejemplo:

• feature/funcionalidad-1
• feature/funcionalidad-2

Plantilla adicional

También podemos agregar otras plantillas a alguna de las plantillas aplicadas (por defecto o de rama). Estas plantillas se ubican en la carpeta:

• carpeta base/pull_request_template/

Por ejemplo:

• carpeta base/pull_request_template/additional.md
• carpeta base/pull_request_template/plantillaAdicional1.md
• carpeta base/pull_request_template/plantillaAdicional2.md

Y podremos usarlas al crear un nuevo PR con el botón "Agregar una plantilla":

Conclusión

Tener una buena descripción en nuestros Pull Request nos ayudará y ayudará al resto del equipo a comprender mejor las nuevas incorporaciones a nuestro proyecto y podremos tener un lineamiento al momento de detallar los cambios.