Crea Pull Requests que Saboreen a la Perfección como en The Bear

Mon Jan 13 2025

Desarrollo

¡Hola Chiquis!👋🏻 ¿Te acuerdas de la frenética cocina de Carmy en The Bear? Cada plato era una obra de arte, pero para que llegara a la mesa, tenía que pasar por un riguroso proceso de preparación y revisión. En el mundo del desarrollo de software, las Pull Requests son como esos platos: son creaciones que necesitan ser evaluadas antes de servirse al público.

En la serie, los personajes trabajan en una cocina donde la precisión, la claridad y la colaboración son esenciales para el éxito. De manera similar, en el desarrollo de software, crear Pull Requests (PR) fáciles de revisar es crucial para mantener la calidad del código y la eficiencia del equipo.

¿Qué es una Pull Request? Imagina que tu código es un nuevo plato que quieres agregar al menú de un restaurante (tu proyecto). Antes de presentarlo a los clientes (el código base principal), necesitas que el chef principal (el revisor) lo pruebe y apruebe. Una Pull Request es esa solicitud formal para que tu nuevo código sea incorporado al proyecto.

¿Cómo crear Pull Requests deliciosas (y fáciles de revisar)? a. Ingredientes de Calidad (Código Limpio):

Código bien formateado: Indentación consistente, nombres de variables claros y comentarios explicativos hacen que tu código sea más fácil de digerir.
Pruebas unitarias: Asegúrate de que cada nueva función o característica esté respaldada por pruebas unitarias. Esto garantiza que tu código funcione como se espera y no introduzca nuevos errores.
Commits atómicos: Cada commit debe representar un cambio lógico y completo. Evita commits gigantescos y confusos.

b. Receta Concisa (Descripción Clara):

Título descriptivo: Resume claramente el objetivo de tu Pull Request.
Descripción detallada: Explica qué problema resuelve tu código y cómo lo logra.
Pasos para reproducir: Si es necesario, incluye instrucciones detalladas sobre cómo probar tu código. c. Presentación Impecable (Formato de la Pull Request):
Ramas claras: Crea una rama dedicada para cada Pull Request para mantener tu código base limpio y organizado.
Conflictos resueltos: Antes de enviar la Pull Request, asegúrate de que no haya conflictos con el código base principal.
Etiquetas: Utiliza etiquetas para categorizar tu Pull Request (por ejemplo, bugfix, feature, refactor).

d. Cocinar a Fuego Lento (Revisión por Pares):

Sé paciente: Espera a que los revisores tengan tiempo para evaluar tu código.
Responde a los comentarios: Agradece los comentarios y realiza los cambios necesarios de manera proactiva.
Mantén una actitud abierta: La revisión por pares es una oportunidad para mejorar tu código y aprender de tus compañeros.

La Cocina y el Desarrollo de Software: Un Paralelo

Carmy: El desarrollador que crea el código.
La cocina: El repositorio de código.
Los platos: Las Pull Requests.
Los chefs: Los revisores de código.
La línea de montaje: El proceso de desarrollo.

Al igual que en la serie, donde cada plato debe cumplir con los estándares más altos de calidad, las Pull Requests deben ser cuidadosamente preparadas y revisadas para garantizar la excelencia del producto final.

Mantén los PR Pequeños y Enfocados En The Bear, cada plato tiene una receta específica y bien definida. De la misma manera, un PR debe ser pequeño y enfocado en una sola tarea o funcionalidad. Esto facilita la revisión y reduce la posibilidad de errores. Ejemplo de PR Enfocado en una Funcionalidad

// Antes: PR grande con múltiples cambios
public class Calculadora {
    public int suma(int a, int b) {
        return a + b;
    }

    public int resta(int a, int b) {
        return a - b;
    }

    public int multiplica(int a, int b) {
        return a * b;
    }

    public int divide(int a, int b) {
        if (b == 0) {
            throw new IllegalArgumentException("División por cero");
        }
        return a / b;
    }
}

// Después: PR enfocado en la funcionalidad de suma
public class Calculadora {
    public int suma(int a, int b) {
        return a + b;
    }
}

Escribe Descripciones Claras y Detalladas En la serie, las órdenes en la cocina deben ser claras y detalladas para evitar confusiones. De manera similar, una descripción clara y detallada del PR ayuda a los revisores a entender el propósito y el contexto de los cambios. Ejemplo de Descripción de PR

### Descripción
Este PR añade la funcionalidad de suma a la clase `Calculadora`.

### Cambios Realizados
- Añadido el método `suma(int a, int b)` a la clase `Calculadora`.

### Cómo Probar
1. Ejecutar los tests unitarios en `CalculadoraTest`.

Verificar que el método suma devuelve el resultado correcto para diferentes entradas. Incluye Pruebas Unitarias En la serie, cada plato se prueba antes de ser servido para asegurar su calidad. De manera similar, incluir pruebas unitarias en tu PR asegura que los cambios funcionan correctamente y no introducen errores. Ejemplo de Pruebas Unitarias

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;

public class CalculadoraTest {
    @Test
    public void testSuma() {
        Calculadora calc = new Calculadora();
        assertEquals(5, calc.suma(2, 3));
        assertEquals(0, calc.suma(-1, 1));
        assertEquals(-5, calc.suma(-2, -3));
    }
}

Solicita Revisión de los Miembros Adecuados del Equipo En The Bear, cada miembro del equipo tiene un rol específico y se encarga de diferentes aspectos de la cocina. De manera similar, asegúrate de solicitar la revisión de los miembros del equipo que tienen el conocimiento adecuado sobre la funcionalidad que estás cambiando. Ejemplo de Solicitud de Revisión

### Revisores Solicitados
- @usuario1: Experto en la funcionalidad de cálculo.
- @usuario2: Responsable de la calidad del código.

Responde a los Comentarios de Manera Constructiva En la serie, la comunicación y la colaboración son clave para el éxito del equipo. De manera similar, responde a los comentarios de los revisores de manera constructiva y realiza los cambios necesarios para mejorar el PR. Ejemplo de Respuesta a Comentarios

### Comentario del Revisor
- @usuario1: "El método `suma` debería manejar el caso de números negativos."

### Respuesta
- @autor: "Gracias por la sugerencia. He añadido pruebas unitarias para manejar el caso de números negativos y he actualizado el método `suma` en consecuencia."

En resumen, crear Pull Requests efectivas es un arte que requiere atención al detalle, comunicación clara y colaboración. Al seguir estos consejos, podremos mejorar la calidad de nuestro código y contribuir de manera más efectiva a todos los proyectos.

Conclusión Al igual que en The Bear, donde la precisión, la claridad y la colaboración son esenciales para el éxito en la cocina, crear Pull Requests fáciles de revisar es crucial para mantener la calidad del código y la eficiencia del equipo. Mantén los PR pequeños y enfocados, escribe descripciones claras y detalladas, incluye pruebas unitarias, solicita revisión de los miembros adecuados del equipo y responde a los comentarios de manera constructiva.

¡Gracias por leer! 👇🏻 🚀 ¿Te ha gustado? Comparte tu opinión. Artículo completo, visita: https://lnkd.in/ewtCN2Mn https://lnkd.in/eAjM_Smy 👩💻 https://lnkd.in/eKvu-BHe https://dev.to/orlidev https://lnkd.in/ecHHabTD https://pin.it/2BuZ9N4n8 https://linktr.ee/orlidevs ¡No te lo pierdas!

Referencias: Imágenes creadas con: Copilot ( microsoft.com )

#PorUnMillóndeAmigos #MakeYourselfVisible

Crea Pull Requests que Saboreen a la Perfección como en The Bear

https://my-million-friend-blog.vercel.app/blog/post-188/