34

Code Review: Consejos para hacer revisión de código y no matar a alguien en el intento

15629Puntos

hace 4 años

Curso profesional de Git y GitHub 2017
Curso profesional de Git y GitHub 2017

Curso profesional de Git y GitHub 2017

Entiende e implementa Git y Github en tu flujo de trabajo. Git y Gihub Son el estándar de la industria para control de versiones de código de tus proyectos. De cero a avanzado.

Si eres desarrollador y trabajas en equipo es muy probable que el Code Review esté dentro de tu flujo de trabajo. Al ser un proceso en el que un integrante del equipo revisa el código que alguien más escribe, puede suceder que dicha crítica se malinterprete y que el autor del código se lo llegue a tomar personal. A su vez, si el que hace la revisión no le pone la dedicación necesaria y deja pasar cosas inadecuadas hará que la calidad del código disminuya. A continuación te daré algunos consejos para que este proceso sea mejor y no cometas este tipo de errores.

¿Cómo funciona un Code Review?

En Platzi, por ejemplo, cada que alguien envía un Pull Request en GitHub, es necesario que otra persona del equipo revise ese código y lo apruebe para que pueda hacer merge con master. Hay quienes prefieren hacerlo verbalmente o por medio de alguna otra herramienta.

Sea cual sea el medio, cuando alguien más revisa tu código aprendes un montón, además de que esto hace que todo el equipo esté en sintonía. Los Code Reviews evitan que errores como faltas de ortografía, comentarios o alguna impresión en consola lleguen a producción. Además, si eres nuevo, esto hará que te adaptes más rápidamente a los estándares establecidos por el equipo. En serio, las revisiones de código no traen más que beneficios para ti y tu equipo.

image001.jpg

Mi primer consejo es que cada cambio que realices sea pequeño, para que la persona que vaya a revisar tu código esté consiente de lo que hiciste y no se agobie con decenas de archivos por revisar. Por otro lado, el Code Review debe ser parte de tu flujo de trabajo como desarrollador. Si eres un desarrollador Senior, tienes la oportunidad de enseñar y orientar a los desarrolladores con menos experiencia que tu. Un desarrollador Junior puede crecer muchísimo como Code Reviewer haciendo preguntas sobre funcionalidades que desconozca.

La revisión de código beneficia a todos, sin importar si trabajas solo o en equipo. Existe la posibilidad de que seas un freelancer o simplemente no tengas un equipo de trabajo. En este caso lo ideal sería que pidieras retroalimentación de una persona externa.

¿Hirieron tus sentimientos?

He escuchado en varias ocasiones historias de desarrolladores con el corazón roto 💔 después de un Code Review. Es completamente normal reaccionar a la defensiva cuando critican algo qué haces. Sin embargo, lo más probable es que la persona que hace el Code Review no esté tratando de ser mala persona contigo al hacer notar errores en tu código sino todo lo contrario, quiere ayudarte ❤️. Es por eso que como reviewer debes tener cuidado en el tono con el que transmites tu crítica, de tal forma que el autor del código no lo vaya a tomar personal.

Captura de pantalla 2017-12-04 a la(s) 12.25.04.png

Mi consejo si eres tú el que va a revisar código es que siempre expliques el por qué cuando indicas que algo está mal y el cómo para evitar que ese error vuelva a ocurrir en el futuro. Recuerda, tampoco se trata de hacer un Code Review pobre por miedo a herir los sentimientos de la otra persona, simplemente da contexto de la situación.

Estos son algunos de mis consejos para ti que he ido aprendiendo a lo largo de mi historia como desarrolladora. Ahora te toca a ti contarnos tu experiencia y lo que has aprendido sobre este tema. ¿El Code Review es parte de tu flujo de trabajo? ¿Te has sentido incómodo después de un comentario sobre la forma en que codeas? Estaré feliz de escuchar tu historia sobre lo que callamos los desarolladores en los comentarios de abajo. 👇🏼

Curso profesional de Git y GitHub 2017
Curso profesional de Git y GitHub 2017

Curso profesional de Git y GitHub 2017

Entiende e implementa Git y Github en tu flujo de trabajo. Git y Gihub Son el estándar de la industria para control de versiones de código de tus proyectos. De cero a avanzado.
Fannytaviles
Fannytaviles
fannytaviles

15629Puntos

hace 4 años

Todas sus entradas
Escribe tu comentario
+ 2
Ordenar por:
2
33869Puntos

Es cierto, yo nunca habia pasado por Code Review y la primera vez que pase fue en mi empleo actual y no estaba preparado para la crítica y hasta me lo tomé personal y me dio molestia, pero luego de pasar varias veces por Code Review y ver todos los consejos que me habian dado pude percatarme de la valiosa enseñanza que es el CR y como no sentirse mal ya que gran parte son críticas constructivas que te hacen crecer como desarollador.

2
15629Puntos
4 años

Suele pasar! Lo importante es tener nuestra mente abierta a recibir feedback e ir por el camino del bien 😃

1
2538Puntos

¡Exacto! Tomárse personal un CR puede ser perjudicial para nuestra salud, toda crítica es constructiva aunque parezca lo contrario, nuestro crecimiento profesional e incluso personal, está basado en las retroalimentaciones.
¡Hasta Pronto!
SERGIOxelmundo

1

Sin ser desarrollador creo que el CR es muy importante no sólo por desempeño y funcionalidad de la(s) aplicacione(s), también es importante incluir checks para revisar funciones de seguridad y prácticas de desarrollo seguras, ahorrandote dolores de cabeza por incidentes de seguridad y/o cubriendo estándares de seguridad

1
37684Puntos

Muchas gracias por tu aporte @fannytaviles, excelente post. Llevo 4 año trabajando como desarrollador, pero en ninguno de mis trabajo, ha existido el Code Review dentro del flujo de trabajo. Pero me gustaría mucho sugerirlo en mi trabajo actual. En caso que no manejemos herramientas como gitHub o gitLab, de que otra manera me podría realizar la revisión (utilizamos SVN)?

0
15629Puntos
4 años

Existen muchas herramientas, por ejemplo crucible pero no necesariamente necesitas de alguna herramienta para empezar a agregar la revisión de código a tu flujo de trabajo. Si tienes la oportunidad de hacerlo verbalmente también funciona. Solo te recomiendo utilizar algún diff antes de mandar algún cambio para que otro dev lo revise. Lo importante es implementarlo, no importa el medio, notarás que podrás prevenir un montón de bugs.

1
13439Puntos

En la empresa en la que acabo de empezar se hace code review y la verdad es que todo son ventajas. Se aprender muchísimo. En nuestro caso para poder hacer merge 2 personas tienen que aprobar tu pull request.

0
15629Puntos
4 años

Genial escuchar esto Jesús. El CR te ayuda a crecer, sin duda.

1
18232Puntos

Recuerdo un code review dónde me decían que porque era así, fue un momento que me ayudo a corregir las “muletillas” que tenía en el código.La verdad la mejor herramienta que se puede tener en equipos de desarrollo para mantener la calidad y aprender a lot.

1
15629Puntos
4 años

Seguro fue una gran persona la que te hizo esos comentarios 🙊

0
10791Puntos

Una vez para una entrevista de trabajo presente un pequeño proyecto que ellos me pidieron realizar antes de la entrevista ya al momento del code review el tio dijo que no tenia nada que decir y que le gustaba mi code. acto seguido no me contrato no se si fue por mi code que en la review no quiso decirme nada o mi edad (17) pero es una anécdota que me parece interesante.

0
2988Puntos

Buenas noches, soy relativamente nuevo en el desarrollo de de software, siempre es bueno tener a alquien que te ayude con tu codigo una nueva perspectiva dentro del equipo de trabajo con el estandar adecuado no solo aprende una persona sino el ejercicio de aprendijzaje es mutuo. saludos
YMHSR.