¿Cómo hacer una revisión de código? Parte 2: revisar navegación, velocidad, comentarios, conflictos

La primera parte del artículo destacó aspectos de los estándares de revisión de código y puntos que deben abordarse primero. En la parte final, hablemos sobre:


  • procedimiento de revisión
  • velocidad (y lo que afecta)
  • cómo escribir comentarios
  • discusión durante la revisión.

1. Navegación a través de la lista de cambios en la revisión


TL; DR


Ahora que comprende a qué debe prestar atención , debe decidir cuál es el orden de la revisión. Hay 3 etapas principales:


  1. Comprenda si la funcionalidad presentada es necesaria en principio y si tiene una buena descripción ;
  2. Preste atención a lo más importante en el código modificado y qué tan bien está diseñada la solución en su conjunto;
  3. Vea los cambios restantes en el orden que considere adecuado.

1.1. Cambiar descripción general


Mire la descripción de CL y su funcionalidad principal: ¿son necesarios estos cambios? Si no se necesita la funcionalidad propuesta, intente informarla lo antes posible y explique los motivos. En este caso, es recomendable ofrecer al desarrollador una tarea a cambio.


: " , , , FooWidget, . . , BarWidget . ?"


, : CL . : , .


, , , — , . "" , , .


1.2.


CL — , . — . CL , , CL .


CL, , CL . , , — .


:


  • CL . , .
  • . , , , .

1.3.


CL , . . , . — .


2.


2.1. - ?


Google , , , . , .


, - :


  • . , , , . , , , , .
  • . , . . , , , CL , . , .
  • . , . , CL.

2.2. ?


- , , .


( , , ).


, CL ( ) .


2.3. vs


, : - , , , . , , . , , , .


: , , , .


2.4.


-, , , , , CL . , .


, , .


, , , CL , . . , — .


, , . , , .


2.5.


, , , , . , .


2.6. LGTM (looks good to me = )


, , CL . :


  • , .
  • , .

LGTM , "LGTM, Approval".


2.6. CL


CL , CL CL, . , .


CL , , CL, , . , , .


2.7. -


, , . , CL . . , , — , .


2.8.


, CL . . , , " ".


3.


TL;DR


  • .
  • .
  • , , .
  • , .

3.1.


, , , , . — , . , , , -, . :


: " , ?"


: " , , . , , ."


3.2.


"" , . , — , .


3.3.


CL, . .


. , , . , , , , , , , , .


, . , CL , — , .


3.4.


, , , . , , , , .


, , . : , , , , , .


4.


, .


4.1. ?


, — , . , . ? ? , .


, . , . , - .


, , , . .


, . , . , .


4.2. ?


, , . , , , , , . , , , . , , .


4.3. " "


( ) , . , - CL, . CL . , , CL, - . , . , — , , , "". .


CL , CL , . CL , , , , TODO- .


4.4.


, , . .


, , , .


Incluso los oponentes más ardientes de las revisiones rigurosas pueden convertirse en sus mayores aliados cuando en la práctica se encuentran con una situación que demuestra que su posición difícil en la revisión fue correcta.


4.5. La resolución de conflictos


Si sigue todas las reglas anteriores, pero de todos modos existen conflictos con los desarrolladores y no puede resolverlos, consulte los Estándares de revisión de código para comprender las prácticas y los estándares que pueden ayudarlo a resolver el conflicto.


All Articles