Na vida de um desenvolvedor, chega um momento em que ele começa a realizar uma revisão de código. Como regra, esse é um dos sinais do crescimento de um programador: ele começa a realmente ouvir sua opinião e confiar em tarefas mais sérias. O momento exato em que um desenvolvedor é solicitado a fazer uma revisão depende da estrutura da empresa: há equipes nas quais mais ou menos tudo pode ser feito após algum tempo, e há aquelas em que o processo de revisão depende inteiramente dos colegas mais antigos e mais experientes.

Ao mesmo tempo, poucas pessoas falam sobre quais princípios devem ser seguidos para realizar uma revisão da qualidade: quais são os principais objetivos desse procedimento, o que procurar em primeiro lugar, a rapidez com que ele precisa ser realizado.

Portanto, o Guia de revisão do Google parece um documento muito valioso, cuja tradução da primeira parte é apresentada posteriormente. As traduções das partes restantes serão divulgadas posteriormente em postagens separadas. Vale a pena notar que esta é uma tradução adaptada, nem todas são traduzidas palavra por palavra, em nome de mais formulações e frases em russo.

Terminologia:

CL : "changelist" - uma lista de alterações de código enviadas ao sistema de controle de versão para revisão. Um análogo de solicitação de recebimento no GitHub ou solicitação de mesclagem no GitLab.

1. Revisão do código de normas

O principal objetivo da revisão é melhorar a base de códigos do Google. Todas as ferramentas e meios utilizados para realizar uma revisão visam especificamente atingir esse objetivo.

No caminho para alcançar o objetivo declarado, temos que fazer uma série de compromissos.

Primeiro, os desenvolvedores devem poder executar suas tarefas. Se você não aceitar nenhuma alteração na base de código, ela nunca melhorará. No caso em que o revisor faz alterações muito complicadas, os desenvolvedores simplesmente não fazem nada no 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),
• -.

Você deve examinar cada linha do código, levar em consideração o contexto , garantir que está melhorando o estado da base de código e incentivar decisões bem-sucedidas do desenvolvedor.

Na próxima parte, discutiremos como navegar melhor no CL e por onde começar a revisão.