Revisiones y aprobaciones de código

Las revisiones de código son fundamentales en el desarrollo de software moderno. Consisten en un examen sistemático del código fuente por parte de otros desarrolladores para encontrar y corregir errores que pasaron inadvertidos durante la fase inicial de desarrollo.

Sus principales objetivos son:

• Mejorar la calidad del código: Detectar pronto errores, vulnerabilidades de seguridad y fallos de diseño.
• Compartir conocimientos: Extender por todo el equipo la comprensión del código base.
• Mentoría: Los desarrolladores sénior pueden orientar a los júnior, y todos aprenden de diferentes perspectivas.

En GitHub, el proceso de revisión de código normalmente sigue estos pasos:

1. Un autor crea un Pull Request (PR) con sus cambios.
2. El autor asigna revisores o solicita su revisión.
3. Los revisores examinan el código y dejan comentarios y sugerencias.
4. El autor responde a los comentarios y envía nuevas confirmaciones a la rama del PR.
5. Cuando están satisfechos, los revisores aprueban los cambios.
6. Por último, el PR se fusiona en la rama principal.

Una buena revisión de código no consiste únicamente en encontrar errores; también busca mejorar la salud general del proyecto. Durante la revisión, tenga en cuenta:

• Corrección: ¿El código hace lo que debe? ¿Hay casos límite?
• Legibilidad: ¿Es fácil de entender? ¿Los nombres de las variables son claros?
• Mantenibilidad: ¿Podrán otras personas modificar o ampliar este código fácilmente más adelante?
• Rendimiento: ¿Hay ineficiencias evidentes?
• Seguridad: ¿Introduce alguna vulnerabilidad?

Como revisor, sus comentarios deben ser siempre constructivos y respetuosos. Recuerde que está revisando el código, no a la persona que lo escribió.

Consejos para hacer comentarios:

• Sea específico: Señale líneas de código concretas.
• Explique el «por qué»: No se limite a decir «cambie esto»; explique *por qué* debería cambiarse.
• Sugiera soluciones: Ofrezca enfoques alternativos o fragmentos de código.
• Sea amable: Use un lenguaje cortés y presuponga buenas intenciones.

GitHub proporciona herramientas eficaces para agilizar el proceso de revisión:

• Comentarios de línea: Haga clic en una línea de la pestaña «Files changed» para añadir directamente un comentario.
• Sugerencias: Puede proponer cambios de código específicos que el autor puede aplicar con un solo clic.
• Revisión resumida: Al final, puede enviar una revisión resumida con el estado «Comment», «Approve» o «Request changes».

Las sugerencias son especialmente útiles para mejoras pequeñas y claras:

// Original Code
- const count = 0;
+ const initialCount = 0; // Better name

Si es el autor de un Pull Request, responder a los comentarios es fundamental. Esto demuestra que participa activamente y que está comprometido con mejorar el código.

Al responder a los comentarios:

• Reconózcalos: Responda a cada comentario, aunque solo sea para decir «¡Buen punto!» o «Hecho».
• Realice cambios: Envíe nuevas confirmaciones a la rama de su PR. GitHub actualizará el PR automáticamente.
• Resuelva las conversaciones: Cuando haya respondido a un comentario, márquelo como «Resolved» en GitHub.
• Haga preguntas: Si no entiende una sugerencia, pida aclaraciones.

El estado «Approve» indica claramente que un revisor está satisfecho con los cambios de un Pull Request. Muchos repositorios están configurados para requerir al menos una aprobación (o más) antes de poder fusionar un PR.

Una aprobación indica que el revisor considera que el código:

• Cumple los requisitos.
• Está bien escrito y es fácil de mantener.
• Ha resuelto todas las cuestiones importantes.

¡Es la luz verde para la integración!

A veces, un Pull Request necesita más trabajo antes de poder fusionarse. En esos casos, un revisor puede elegir «Request changes» como estado de su revisión.

Este estado comunica claramente que:

• Hay problemas bloqueantes que deben resolverse.
• El PR no se puede fusionar hasta que se realicen estos cambios y el revisor emita una nueva aprobación.

Use esta opción cuando los problemas sean importantes e impidan aceptar el código.

Para aprovechar al máximo las revisiones de código, tanto los autores como los revisores deben seguir algunas buenas prácticas:

• Mantenga los PR pequeños: Los PR más pequeños son más fáciles y rápidos de revisar.
• Descripciones claras: Los autores deben proporcionar descripciones detalladas del PR y el contexto necesario.
• Sea diligente: Los revisores deben intentar revisar rápidamente; los autores deben responder con prontitud.
• Automatice todo lo posible: Use linters y pruebas automatizadas para detectar problemas sencillos antes de la revisión.
• Aprenda de las revisiones: Considere cada revisión como una oportunidad para aprender y mejorar.

Según lo que hemos aprendido, ¿cuáles de las siguientes se consideran buenas prácticas al participar en revisiones de código?

¡Ha explorado el mundo de las revisiones de código y las funciones de aprobación de GitHub! Hemos visto por qué las revisiones son esenciales para la calidad del código y el intercambio de conocimientos, el flujo habitual de una revisión y los elementos clave de unas buenas prácticas de revisión.

Recuerde proporcionar siempre comentarios constructivos, utilizar herramientas de GitHub como las sugerencias y seguir buenas prácticas tanto al revisar como al responder a los comentarios. Las aprobaciones y «Request changes» son señales fundamentales para gestionar sus PR de forma eficaz.

¡Siga practicando estas habilidades para convertirse en un colaborador valioso!