Revisiones de código para convertirse en un mejor desarrollador
En mi experiencia, participar en una revisión de código es la forma más efectiva de subir de nivel como desarrollador. Si es el creador de los cambios revisados, puede obtener comentarios directos de sus colegas. Y si usted es uno de los revisores, puede aprender diferentes enfoques en los que quizás no haya pensado sobre cómo resolver implementaciones.
Pero dar correctamente y también comprender una revisión de código es una habilidad que debe aprenderse. En este artículo, simplemente enumeraré algunos aspectos que considero al dar y recibir revisiones de código. Desde mi punto de vista, han demostrado ser la elección correcta para un entorno de desarrollo colaborativo y acogedor.
Lo que defino como buen código
Recuerde que no hay nada más permanente que una solución temporal.
Las siguientes métricas clave me guían al escribir y revisar el código.
- el código es mantenible, p. no hay trucos ni soluciones, aunque esté bien documentado
- el código es fácilmente legible, por lo que razonar sobre él es mucho más fácil
- el código es comprobable, mejorando así aún más los dos puntos anteriores
Cómo dar una revisión de código
Se humilde
Estar equivocado no es un problema. Insistir en que tienes razón aunque objetivamente no la tengas es un problema. Siempre tenga en cuenta que puede perderse algo o simplemente malinterpretar el código. Esté abierto al rechazo y sea humilde para tener la oportunidad de aprender algo nuevo.
Las revisiones de código no son personales.
Recuerda: el código es lo primero. Puede revisar el código de alguien en una situación tensa en la que ninguno de los dos está de humor para hablar entre sí o, en general, no están de acuerdo con la forma en que funcionan las cosas actualmente.
Las revisiones de código no son el lugar para desahogarse o para pagar las frustraciones. El único propósito de las revisiones es mejorar objetivamente la calidad del código. El código que revisa y que se fusionará es el siguiente código heredado, por lo tanto, es importante dejar de lado las cosas personales y proporcionar una revisión objetiva, sin importar quién sea el revisado.
Las opiniones no son reseñas
Una diferencia clave entre una buena reseña y solo un comentario es que las reseñas dejan de lado las opiniones. Por ejemplo, no importa cómo se vea el estilo del código, siempre que sea mantenible, fácil de leer y comprobable. Si no está seguro de si su revisión sería obstinada, simplemente agregue un comentario para que pueda discutir el punto con su colega.
Las buenas críticas conducen a buenas discusiones.
Desafiar una revisión puede conducir a grandes transferencias de conocimiento entre desarrolladores. Una revisión determinada no debe tratarse como un comentario final, sino como un punto de partida para las discusiones para obtener una imagen completa. Es posible que ambos se pierdan algo y discutir las críticas solo puede mejorar sus ideas.
Los plazos no importan
No siempre es fácil de hacer cumplir, pero omitir las revisiones de código puede potencialmente crear una gran deuda técnica que nadie estará dispuesto a limpiar. Es importante mantener la disciplina necesaria para realizar revisiones exhaustivas del código, incluso si escucha el tictac del reloj. ¡Tú podrías ser el próximo desarrollador en trabajar en este lío!
Usar enlaces para referencias
La comparación del código revisado con uno existente ocurre con bastante frecuencia. Por lo tanto, es importante incluir correctamente las referencias a través de enlaces. Solo mencionar el lugar aproximado donde se encuentra el código de referencia no es suficiente.
Use la función de su control de fuente para resaltar el código en una rama existente y use las URL creadas en su revisión como referencia. Lo mismo se aplica a la documentación externa, por ejemplo en MDN.
Cómo leer una revisión de código
Todo lo anterior
Leer revisiones de código de su código lo convierte en un mejor desarrollador cuando sigue todos los puntos mencionados anteriormente. Sea humilde, no tome las críticas como algo personal y esfuércese por comprender lo que señala una revisión para comprender mejor el panorama general.
Una opinión personal de cómo ser objetivo.
Este artículo refleja mi enfoque personal sobre las revisiones de código. Los puntos descritos son solo la culminación de mi experiencia como desarrollador en equipos grandes y pequeños, tanto a nivel local como internacional. Han demostrado que funcionan, lo que lleva a un mejor código y me da la oportunidad de aprender directamente de los demás.
