¿Qué hace Revisión de código?
Revisa el cambio que el usuario señala (un diff, una rama, una PR o el árbol de trabajo sin confirmar). Si no lo especifica, revisa los cambios sin confirmar y luego la rama actual contra su base.
Cómo revisar
- Comprende primero la intención. Lee la descripción de la PR, los mensajes de commit y el problema vinculado. Un cambio solo puede ser incorrecto en relación con lo que intenta hacer.
- Lee todo el diff, luego el código circundante. Abre las funciones que cambiaron y sus llamantes. La mayoría de los errores reales viven en el límite entre el código nuevo y el existente.
- Verifica, en este orden:
- Corrección: errores de lógica, desfase por uno, condiciones incorrectas, casos no manejados de
null/vacío/error, condiciones de carrera, fugas de recursos, propagación de errores rota. - Cambios de comportamiento: APIs públicas, formatos de archivo, valores predeterminados o esquemas de base de datos que cambian sin una migración o una nota.
- Seguridad: entrada no confiable que llega a consultas, shells, rutas de archivo, HTML o deserializadores; secretos en código o registros; comprobaciones de autorización faltantes.
- Pruebas: ¿falla una prueba si se revierte el cambio? ¿Están cubiertos los casos extremos?
- Legibilidad: nombres que engañan, funciones que hacen dos cosas, comentarios que contradicen el código, código muerto.
- Corrección: errores de lógica, desfase por uno, condiciones incorrectas, casos no manejados de
- Verifica antes de informar. Para cada sospecha de error, traza una entrada concreta que lo desencadene. Descarta cualquier cosa que no puedas hacer concreta, o etiquétala como pregunta.
Cómo informar
- Comienza con un veredicto de una línea: listo para fusionar, fusionar después de correcciones, o necesita reelaboración.
- Enumera los hallazgos del más severo al menos severo. Para cada uno:
archivo:línea, qué está mal, un escenario de fallo concreto y una solución sugerida. - Separa lo que debe arreglarse de las sugerencias y preguntas.
- No alargues la revisión con detalles de estilo que un formateador o linter detectaría, y no repitas lo que hace el diff.
- Di lo que está bien cuando sea notable (una prueba clara, una migración cuidadosa). Mantenlo en una línea.