Chuck's Academy

Git y Github

Pull requests y revisiones de código

En este módulo, aprenderemos cómo utilizar Pull Requests (PRs) y realizar revisiones de código en GitHub. Los PRs son fundamentales para el trabajo colaborativo, ya que permiten revisar y discutir cambios antes de fusionarlos en la rama principal del proyecto.

¿Qué es un Pull Request?

Un Pull Request (PR) es una solicitud para fusionar cambios desde una rama a otra. Permite a otros miembros del equipo revisar, discutir y aprobar los cambios antes de fusionarlos. Los PRs son esenciales para mantener la calidad del código y garantizar que todos los cambios sean revisados antes de integrarlos en la rama principal.

Creación de un Pull Request

Paso 1: Realizar cambios y subirlos a una rama

Primero, realiza los cambios en una nueva rama y sube esos cambios al repositorio remoto.

bash

Paso 2: Crear el PR en GitHub

  1. Navega a la página del repositorio en GitHub.
  2. Haz clic en la pestaña "Pull requests".
  3. Haz clic en "New pull request".
  4. Selecciona la rama con tus cambios (ej. nueva-funcionalidad) y la rama de destino (ej. main).
  5. Proporciona un título y una descripción detallada del PR.
  6. Haz clic en "Create pull request".

Revisión de código

Asignación de revisores

Una vez creado el PR, puedes asignar revisores para que inspeccionen tu código:

  1. En la página del PR, busca la sección "Reviewers".
  2. Asigna uno o más revisores que revisarán tu PR.

Proceso de revisión

Los revisores pueden hacer comentarios sobre líneas específicas de código, sugerir cambios y aprobar o solicitar modificaciones.

Comentarios en líneas de código

Los revisores pueden dejar comentarios directamente en las líneas de código:

  1. En la vista del PR, haz clic en las líneas de código específicas.
  2. Deja un comentario explicando la sugerencia o problema.

Solicitar cambios

Si el PR necesita ajustes, los revisores pueden solicitar cambios:

  1. En la parte superior de la vista del PR, haz clic en "Files changed".
  2. Haz clic en el botón "Review changes".
  3. Selecciona "Request changes", agrega un comentario, y haz clic en "Submit review".

Aprobar cambios

Si todo está correcto, los revisores pueden aprobar el PR:

  1. En la parte superior de la vista del PR, haz clic en "Files changed".
  2. Haz clic en el botón "Review changes".
  3. Selecciona "Approve" y haz clic en "Submit review".

Fusión de un Pull Request

Fusionar el PR

Una vez que los revisores aprueben el PR, puedes fusionarlo:

  1. En la página del PR, haz clic en el botón "Merge pull request".
  2. Confirma la fusión haciendo clic en "Confirm merge".

Eliminar la rama fusionada

Después de fusionar el PR, es buena práctica eliminar la rama que ya no es necesaria:

  1. En la página del PR, haz clic en "Delete branch".

Buenas prácticas para Pull Requests y revisiones de código

  • Títulos y descripciones claras: Proporciona títulos y descripciones detalladas para que los revisores entiendan el propósito de los cambios.
  • Commits pequeños y coherentes: Realiza commits pequeños y descriptivos para facilitar la revisión.
  • Respuestas a comentarios: Siempre responde a los comentarios de los revisores, ya sea aceptando las sugerencias o explicando tu razonamiento.
  • Resolución de conflictos antes de la fusión: Si el PR tiene conflictos, resuélvelos antes de solicitar una revisión final.

Herramientas adicionales

Uso de plantillas para PRs

Puedes crear plantillas de PR para asegurar que se incluyan todos los detalles necesarios:

  1. Crea un archivo .github/pull_request_template.md en tu repositorio.
  2. Añade una descripción con secciones que deseas que se completen en cada PR.

Automatización con GitHub Actions

Configura GitHub Actions para automatizar pruebas, análisis de código y otras tareas cuando se cree o actualice un PR.

yaml

Ejemplo práctico

  1. Crear y trabajar en una nueva rama:

    bash
  2. Crear un Pull Request en GitHub.

  3. Asignar revisores y recibir comentarios.

  4. Realizar cambios adicionales si es necesario y hacer push:

    bash
  5. Revisar y aprobar el PR.

  6. Fusionar el PR y eliminar la rama.

Con estas técnicas y flujos de trabajo, puedes gestionar PRs y revisiones de código de manera efectiva en GitHub, asegurando que todos los cambios sean revisados y aprobados antes de ser fusionados a la rama principal. En el próximo módulo, aprenderemos sobre el uso avanzado de Git, incluyendo rebase y cherry-pick.


Pregúntame lo que sea