El arte del code-review
Antes de trabajar en PayPal, como Software Engineer, no veía la importancia del code review. Y lo consideraba una tarea tediosa y aburrida. Pero ahora, después de 5 años como desarrollador, me gustaría compartir 5 ideas que cambiaron mi percepción sobre el proceso del code review:
Una oportunidad para aprender: Cuando empezaba en la empresa, una de mis primeras tareas, fue cambiar una simple línea de css, para cambiar el estilo de un mensaje de texto. Por lo tanto, yo esperaba que al abrir el PR, todos lo aprobarían de inmediato. Pero para mi sorpresa, fue todo lo contrario. Se inició una discusión en ese mini PR, sobre porque si y porque no, esa propiedad tenía que agregarse. Es por ello, que considero el code-review como una oportunidad enorme, para aprender.
Lo que es entendible para mí, no lo es necesariamente para todos: Todos los que alguna vez hemos escrito código, sabemos lo difícil que es elegir el nombre adecuado para una variable. Muchas veces, ese nombre se define basado en el rol que esa variable tiene en el código, o simplemente por convención. Pero muchas veces, ese nombre no transmite el significado que yo percibí, en las demás personas. Es por ello que el feedback del equipo es esencial, para definir nombres adecuados.
No es nada personal: Muchas personas se frustran, al observar un Needs work o un Please, could you change.... Al contrario, el feedback del equipo es sumamente valioso, y debe tomarse como una oportunidad para retar a tu código, o justificarlo adecuadamente, si es lo suficientemente bueno, como nosotros pensamos.
Promueve la consistencia: Hoy en día, existe una enorme cantidad de linters que ayudan a mantener la consistencia en el código. Pero, el code review también es un espacio para fomentar consistencia, por ejemplo al nombrar variables, funciones.
Identifica posibles errores: Una practica, que quizá muy pocos desarrolladores toman en cuenta al momento de una revisión de código, es la ejecución del código. Obviamente, es entendible, porque ejecutar el código de alguien más, puede ser una tarea que tome mucho tiempo, y se necesita una configuración del ambiente, de forma previa. Esto nos ayuda a entender mejor el PR que se está revisando, y lo mejor de todo, es que nos permite testearlo. Donde podemos identificar errores, que el owner del código no había considerado.
Muchas veces, es una cuestión de tiempo lo que nos limíta a efectuar una sesión de revisión de código. Como recomendación, reservar 20-30 minutos al día puede ser suficiente, para fomentar y crear el hábito de un code review efectivo.