En la vida de un desarrollador, llega un momento en que comienza a realizar una revisión del código. Como regla, este es uno de los signos del crecimiento de un programador: comienzan a escuchar realmente su opinión y confían en tareas más serias. El momento exacto en que se le pide a un desarrollador que haga una revisión depende de la estructura de la empresa: hay equipos en los que se puede hacer más o menos todo después de que haya transcurrido un tiempo, y hay aquellos en los que el proceso de revisión recae completamente en los colegas más antiguos y experimentados.
Al mismo tiempo, pocas personas hablan sobre los principios que deben seguirse para realizar una revisión de calidad: cuáles son los objetivos principales de este procedimiento, qué buscar en primer lugar, qué tan rápido debe hacerse.
Por lo tanto, la Guía de revisión de Google parece un documento muy valioso, cuya traducción de la primera parte se presenta más adelante. Las traducciones de las partes restantes se publicarán más adelante en publicaciones separadas. Vale la pena señalar que esta es una traducción adaptada, no todas se traducen palabra por palabra, en nombre de más formulaciones y oraciones en ruso.
Terminología:
CL : "lista de cambios": una lista de cambios de código enviados al sistema de control de versiones para su revisión. Un análogo de Pull Request en GitHub o Merge Request en GitLab.
1. Revisión del código de normas
El objetivo principal de la revisión es mejorar la base de código de Google. Todas las herramientas y los medios utilizados para realizar una revisión están dirigidos específicamente a lograr este objetivo.
En el camino para lograr el objetivo declarado, tenemos que hacer una serie de compromisos.
Primero, los desarrolladores deberían poder hacer sus tareas. Si no acepta ningún cambio en la base del código, nunca mejorará. En el caso de que el revisor haga cualquier cambio demasiado complicado, los desarrolladores simplemente no van a hacer nada en el futuro.
, CL , . , . , .
, . , , , " ".
, , :
CL , , CL .
.
, : CL , , , .
, : , . CL , , CL , , . , , . CL, , , , .
, , , , . , , "Nit: ", .
: CL, . .
1.1.
- , , . , , - . , . , ( ), "Nit: " .
1.2.
- .
- style guide .
, style guide . , . - .
/ , . .
, , , . . - , , , , .
1.3.
, , , , : CL .
, : . , CL, .
, — , , , . CL "" , .
2.
: - .
2.1. ()
, — CL . CL? : ? ? ?
2.2.
CL , ? ? "" ( ), , .
, . , , , , , , .
, CL: , . , .
, — CL . , — . , , . ( ).
2.3.
CL — , , . , -, , -, .
, , , . , , , , . , .
2.4.
, , : , end-to-end . , CL, .
.
— , , .
, ? , ? , ? ?
, — , . , , .
2.5.
, . , , , , .
2.6.
, ? ? , , , , , : , . , . , , , : , .
, CL: , "TODO", , .
, — , . , .
2.7.
Google , . , CL .
, , ("Nit:"). CL .
CL . , . , , , CL — , .
2.8.
CL , , , , , README, g3doc (. — Google ) . CL , , . , .
2.9.
. , , , , . , - — . , .
, , , . Google . , , , , . , , , , .
, , , . , , , , .
2.10.
, , . , , : , , 4 , , 50 .
CL : CL , ?
CL, . , , CL.
2.11.
CL , : , . , , .
:
- ,
- ,
- : , ,
- ,
- ,
- ,
- ,
- , , ,
- , , ( ),
- (g3doc),
- -.
Debe mirar cada línea del código, tener en cuenta el contexto , asegurarse de que está mejorando el estado de la base del código y alentar decisiones exitosas del desarrollador.
En la siguiente parte, discutiremos cómo navegar mejor en el CL y dónde comenzar la revisión.