La revisión del código consiste en que los autores inviten a otros desarrolladores a dar su opinión sobre el código antes de que forme parte de nuestra base de código. Es más que sólo detectar errores; es un esfuerzo de equipo hacer que nuestro código sea aún mejor, compartir conocimientos y defender los estándares de codificación juntos.
Beneficios de la revisión de código
Calidad de código mejorada: las revisiones de código desempeñan un papel vital en la mejora de la calidad general del código. Identifican errores, problemas de rendimiento, vulnerabilidades de seguridad y otras fallas en las primeras etapas del proceso de desarrollo.
Compartir conocimientos: a través de revisiones de código, los miembros del equipo pueden aprender unos de otros y obtener conocimientos más profundos sobre la base del código y los estándares de codificación.
Consistencia: las revisiones de código garantizan que los estándares de codificación y las mejores prácticas se apliquen de manera consistente durante todo el proyecto.
Colaboración en equipo: las revisiones de código crean una atmósfera de apoyo, lo que mejora el trabajo en equipo y la confianza dentro del equipo.
Mejora continua: al ofrecer comentarios e identificar áreas de mejora, las revisiones de código ayudan a los desarrolladores a mejorar sus habilidades de codificación y perfeccionar sus prácticas.
Revisión de código Inconvenientes
Consume mucho tiempo: las revisiones de código pueden llevar mucho tiempo, especialmente para bases de código grandes o proyectos complejos.
Retrasos en el desarrollo: las revisiones de código pueden causar un pequeño retraso en el proceso de desarrollo, ya que es posible que los desarrolladores tengan que esperar a que se revise su código antes de seguir adelante.
Sobrecarga de retroalimentación: las revisiones de código pueden brindar a los desarrolladores una gran cantidad de retroalimentación, lo que dificulta su manejo.
Calidad de los revisores: la calidad de los comentarios y la revisión del código puede variar según la experiencia y el conocimiento que tengan los revisores.
Resistencia a los comentarios: los desarrolladores pueden resistirse a los comentarios o sugerencias de los revisores, lo que podría generar conflictos y retrasos en el progreso.
Mejores prácticas de revisión de código
El proceso de revisión del código implica diferentes perspectivas: el autor del código, que solicita comentarios, y los revisores del código, que revisan el cambio de código y brindan comentarios. Si bien algunas prácticas recomendadas son específicas para autores o revisores, muchas benefician a todos los miembros del equipo.
Hoy, hablaremos sobre las mejores prácticas de revisión de código que se centran principalmente en GitHub y revisiones de solicitudes de extracción (PR), pero con consejos aplicables en todos los ámbitos.
1. Cosas que realmente importan:
Para mantener las cosas amigables y productivas durante las revisiones de código, es útil contar con algunas pautas. Esto es en lo que sugerimos centrarse:
- Diseño: ¿El código está bien diseñado y es adecuado para su sistema?
- Funcionalidad: ¿El código funciona como esperaba el autor? ¿Beneficia a sus usuarios?
- Complejidad: ¿Se puede simplificar el código? ¿A otros desarrolladores les resultará fácil de entender y utilizar en el futuro?
- Pruebas: ¿Existen pruebas automatizadas adecuadas y bien construidas para el código?
- Denominación: ¿El desarrollador eligió nombres claros para variables, clases, métodos, etc.?
- Comentarios: ¿Son los comentarios claros y útiles?
- Estilo: ¿El código sigue nuestras guías de estilo ?
- Documentación: ¿El desarrollador también actualizó la documentación relevante?
Es mejor que los desarrolladores no pierdan su tiempo revisando cosas que se pueden verificar automáticamente.
2. Debatir el enfoque de alto nivel con antelación
Antes de profundizar en la codificación de una característica compleja, es bueno hablar primero sobre el panorama general. Por lo general, hacemos esto cuando planificamos la función.
No es muy agradable si un RP termina necesitando una revisión completa porque no discutimos el enfoque de antemano. Las reescrituras de relaciones públicas ocurren de vez en cuando, pero es un indicio de que deberíamos tener una charla más exhaustiva antes de sumergirnos.
A veces, para que todo funcione, necesitamos una prueba de concepto. Una excelente manera de comenzar es abriendo un borrador de relaciones públicas del enfoque y tomando decisiones arquitectónicas basadas en lo que aprendemos.
3. Utilice listas de verificación de revisión de código
El uso de una lista de verificación de revisión de código ayuda a garantizar la coherencia entre todos los miembros del equipo involucrados en la codificación o revisión. Apoya tanto a los desarrolladores experimentados como a los recién llegados brindándoles orientación sobre las mejores prácticas para su lenguaje o marco.
El 50% de las empresas dedican entre 2 y 5 horas semanales a revisar el código . Puede agilizar este proceso con una lista de verificación y los desarrolladores ahorrarán tiempo.
4. Mantenga pequeñas las solicitudes de extracción
Dividir las tareas en lotes más pequeños las hace más manejables y eficientes. Es fundamental considerar no sólo el número de líneas sino también el número de archivos afectados por el cambio.
Concentrarse en secciones más pequeñas permite a los revisores inspeccionar minuciosamente todos los aspectos (considere utilizar una lista de verificación de revisión de código). Con relaciones públicas más pequeñas, los desarrolladores pueden comprender rápidamente los cambios de código y los revisores pueden brindar comentarios más centrados y detallados. Este enfoque garantiza que cada cambio reciba la atención que merece y facilita el seguimiento de la guía de estilo.
5. Fomentar una cultura de retroalimentación positiva
El proceso de revisión del código debe verse como una oportunidad para el crecimiento y el intercambio de conocimientos, en lugar de una crítica de las capacidades de los desarrolladores.
Para que las revisiones de código sean exitosas, es fundamental establecer una cultura de colaboración y aprendizaje. A continuación se muestra una lista de sugerencias para mejorar las discusiones sobre revisión de código:
- Proporcione siempre comentarios sobre el código, no sobre el autor.
- Esté abierto a los cambios sugeridos.
- Informar a quienes se benefician de esta revisión.
- Admita que existen múltiples soluciones correctas para cada problema.
- Proporcione comentarios positivos y útiles.
Esto permite al equipo de desarrollo conocer el propósito detrás de la revisión del código y tomarlo como una forma de mejorar sus capacidades y destrezas de codificación.
6. Automatizar tanto como sea posible
La revisión del código es importante, pero lleva mucho tiempo. Por tanto, es recomendable automatizar las tareas que se puedan automatizar.
Utilice GitHub Actions para crear una canalización de CI sólida. Las comprobaciones automatizadas liberan a los revisores para concentrarse en áreas importantes. ayuda a mejorar la calidad del código y aumentar el nivel de velocidad, precisión y coherencia.
Con GitHub Actions, los desarrolladores pueden ahorrar tiempo y evitar la frustración de tener que verificar manualmente la calidad. La acción recopila y organiza automáticamente todas las pruebas relevantes, cobertura de pruebas, comprobaciones de estilo de código, estándares de mensajes de confirmación, análisis estático y mucho más.
Para conoce más Click aquí
