Como fazer uma revisão de código? Parte 2: revisão da navegação, velocidade, comentários, conflitos

A primeira parte do artigo destacou aspectos dos padrões de revisão de código e pontos que precisam ser abordados primeiro. Na parte final, vamos falar sobre:


  • procedimento de revisão
  • velocidade (e o que isso afeta)
  • como escrever comentários,
  • discussão durante a revisão.

1. Navegação pela lista de alterações na revisão


TL; DR


Agora que você entende o que precisa prestar atenção , precisa decidir qual é a ordem da revisão. Existem três estágios principais:


  1. Entenda se a funcionalidade apresentada é necessária em princípio e se possui uma boa descrição ;
  2. Prestar atenção à coisa mais importante no código modificado e quão bem a solução foi projetada como um todo;
  3. Veja as alterações restantes na ordem que desejar.

1.1 Visão Geral da Mudança


Veja a descrição do CL e sua principal funcionalidade: essas alterações são necessárias? Se a funcionalidade proposta não for necessária, tente relatá-la o mais rápido possível e explique os motivos. Nesse caso, é aconselhável oferecer ao desenvolvedor uma tarefa em troca.


: " , , , 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.


, , . .


, , , .


Mesmo os oponentes mais fervorosos de críticas rigorosas podem se tornar seus maiores aliados quando, na prática, encontram uma situação que prova que sua posição difícil na crítica estava correta.


4.5 Resolução de conflitos


Se você seguir todas as regras acima, mas de qualquer maneira houver conflitos com os desenvolvedores e não puder resolvê-las, consulte os Padrões de Revisão de Código para entender as práticas e os padrões que podem ajudá-lo a resolver o conflito.


All Articles