Hola Habr! Le presento la traducci贸n del art铆culo "6 consejos para una revisi贸n exitosa del c贸digo" .
La revisi贸n de c贸digo siempre ha sido la pr谩ctica fundamental de crear c贸digo limpio y f谩cil de mantener.
A menudo, los desarrolladores descuidan y subestiman la revisi贸n del c贸digo por razones que parecen objetivamente correctas en ese momento.
Formulemos 6 consejos hoy para realizar una revisi贸n de c贸digo fruct铆fera y de calidad .
I - Elige el momento adecuado
La revisi贸n del c贸digo comienza eligiendo el momento correcto .
Tratemos de describir sus caracter铆sticas:
- Baja posibilidad de ser interrumpido : debe evitar las horas de trabajo, durante las cuales, seg煤n la experiencia, las personas tienden a distraerse del proceso de trabajo. De hecho, algunos d铆as a menudo tienen per铆odos m谩s tranquilos, y en esos momentos vale la pena planificar una revisi贸n del c贸digo.
- Una mente limpia y clara : no debe experimentar estr茅s antes del inicio de la revisi贸n y en el proceso, por ejemplo, por temor a una pr贸xima reuni贸n con el cliente. Adem谩s, el programador cuyo c贸digo se debe verificar debe estar en un estado tranquilo para que no haya tensi贸n entre ustedes que pueda destruir el proceso de revisi贸n del c贸digo.
- El desarrollador garantiza que el c贸digo est谩 listo para la verificaci贸n : no tiene sentido perder el tiempo mirando lo que a煤n no est谩 listo. Por disposici贸n se entiende que el c贸digo funciona, sin malas pr谩cticas, documentado y al menos cubierto por las pruebas de la Unidad. Seg煤n la experiencia, si un desarrollador mismo asigna tiempo para una revisi贸n de c贸digo, entonces es m谩s probable que d茅 un c贸digo de verificaci贸n por el cual no se averg眉enza.
II - Establecer los l铆mites
Vale la pena comprender de antemano la pr贸xima escala de revisi贸n de c贸digo.
驴Considera una o m谩s caracter铆sticas? Dado el tiempo, 驴tiene sentido considerar demasiado?
Como regla, quiero centrarme en un n煤mero limitado de cambios para comprender mejor de qu茅 se tratan y no saltar con demasiada frecuencia entre partes del c贸digo.
Para establecer los l铆mites de la tarea correctamente, puede:
- Realizar tareas asignadas de un tama帽o visible . Para hacer esto, divida las tareas grandes en tareas peque帽as y at贸micas, por ejemplo, en Jira o incluso en el tablero Scrum cl谩sico.
- Priorice correctamente la validaci贸n del c贸digo : si hay demasiadas tareas en espera de verificaci贸n, no podr谩 ver todo. Elige prioridad.
III - Establecer la atm贸sfera correcta
Antes de comenzar una revisi贸n del c贸digo, establezca un ambiente favorable a su alrededor.
驴Qu茅 se requiere para esto?
- N煤mero m铆nimo de sonidos extra帽os : ser谩 m谩s productivo si hay el menor ruido posible alrededor. Despu茅s de todo, cuanto m谩s peque帽o es, mejor es la concentraci贸n.
- No existe una zona de "interrupci贸n" : similar a lo que se describi贸 en la primera parte, vale la pena evitar los momentos en que pueden separarse del proceso. Es m谩s f谩cil hacer esto en una habitaci贸n separada.
- Zona de cr铆tica positiva : criticar el trabajo de otra persona es un proceso complejo. Pero es a煤n m谩s dif铆cil hacer esto cuando hay mucha gente alrededor. En una habitaci贸n cerrada, puedes hablar libremente sin temor a que te escuchen a escondidas.
IV - Chatea, chatea y vuelve a chatear
La verificaci贸n del c贸digo no es un proceso unidireccional.
Una revisi贸n exitosa del c贸digo depende en gran medida de la capacidad de comunicarse respetuosa y efectivamente con un colega. Despu茅s de todo, no solo el inspector declara lo que est谩 bien y lo que no.
La revisi贸n de c贸digo es una conversaci贸n sobre todo: alcance, intenciones, correcciones e incluso desacuerdos.
En el proceso, intente cumplir con las siguientes recomendaciones:
- No solo escucha, sino que escucha : las opiniones y opiniones a menudo difieren, y cada desacuerdo debe dar lugar a una discusi贸n constructiva sobre el tema. Cada punto de vista necesita atenci贸n.
- Tono neutral : verificar el c贸digo no es un examen o la Inquisici贸n. Haga que parezca que vino a juzgar el c贸digo, no a la persona que lo escribi贸.
- Las dudas atormentan: especifique : si no est谩 seguro de los detalles de implementaci贸n espec铆ficos, pregunte al respecto. Algunas intenciones que no son obvias a primera vista a menudo dan lugar a malas interpretaciones en el futuro.
V - Recuerda el objetivo final
La revisi贸n del c贸digo debe conducir al resultado final: puede ser una cr铆tica constructiva y consejos para mejorar o integrar el c贸digo con las ramas de desarrollo correspondientes que se seleccionan en gitflow.
Esta es responsabilidad del revisor.
Pero, 驴c贸mo juzga si el c贸digo puede integrarse?
Aqu铆 hay algunos criterios para ayudar con la decisi贸n:
- El c贸digo escrito resuelve el problema descrito en la declaraci贸n.
- El c贸digo est谩 cubierto correctamente por pruebas unitarias .
- Los conflictos de fusi贸n resueltos correctamente.
- No hay signos evidentes de olor a c贸digo o malas pr谩cticas .
VI - Use herramientas especiales
Existen herramientas para una f谩cil verificaci贸n del c贸digo. Puede usarlos sin dudarlo para simplificar el proceso de revisi贸n e integraci贸n de c贸digo.
Tres marcas lideran el mercado de software de verificaci贸n de c贸digo: Smartbear (con Collaborator) , Perforce (con Helix Swarm) y Atlassian (con Crucible)
Dichas herramientas a menudo proporcionan herramientas extensas para organizar la revisi贸n del C贸digo, as铆 como m茅tricas para mantener a su equipo mejorando constantemente.
Esto es mucho m谩s que herramientas para comparar c贸digos, y se integran con casi todos los sistemas de control de versiones disponibles.
隆Pru茅balo!
隆Es tu turno de compartir!
Si tiene consejos adicionales o ejemplos espec铆ficos que le sucedieron en la vida diaria de los desarrolladores, comp谩rtalos en los comentarios.