Comment faire une revue de code? Partie 2: revoir la navigation, la vitesse, les commentaires, les conflits

La première partie de l' article a souligné les aspects des normes de révision du code et les points qui doivent être abordés en premier. Dans la dernière partie, parlons de:


  • procédure d'examen
  • vitesse (et ce qu'elle affecte)
  • comment rédiger des commentaires,
  • discussion durant l'examen.

1. Navigation dans la liste des modifications de la révision


TL; DR


Maintenant que vous comprenez ce à quoi vous devez faire attention , vous devez décider quel est l'ordre de l'examen. Il y a 3 étapes principales:


  1. Comprendre si la fonctionnalité présentée est nécessaire en principe et si elle a une bonne description ;
  2. Faire attention à la chose la plus importante dans le code modifié et à la façon dont la solution est conçue dans son ensemble;
  3. Affichez les modifications restantes dans l'ordre qui vous convient.

1.1. Présentation des modifications


Regardez la description du CL et ses principales fonctionnalités: ces changements sont-ils nécessaires? Si la fonctionnalité proposée n'est pas nécessaire, essayez de la signaler dès que possible et d'expliquer les raisons. Dans ce cas, il est conseillé de proposer au développeur une tâche en retour.


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


, , . .


, , , .


Même les adversaires les plus ardents des révisions strictes peuvent devenir vos plus grands alliés quand, en pratique, ils rencontrent une situation prouvant que votre position difficile dans la révision était correcte.


4.5. Résolution de conflit


Si vous suivez toutes les règles ci-dessus, mais qu'il y a toujours des conflits avec les développeurs et que vous ne pouvez pas les résoudre, reportez-vous aux normes de révision du code pour comprendre les pratiques et les normes qui peuvent vous aider à résoudre le conflit.


All Articles