Table des matières:

Comment rédiger une revue de code ?
Comment rédiger une revue de code ?

Vidéo: Comment rédiger une revue de code ?

Vidéo: Comment rédiger une revue de code ?
Vidéo: 👨‍🏫 Comment faire une revue de code ? | TUTO | GitLab | 2024, Novembre
Anonim

10 conseils pour vous guider vers une revue de code par les pairs efficace

  1. Revoir moins de 400 lignes de code à la fois.
  2. Prends ton temps.
  3. Ne pas revoir pendant plus de 60 minutes d'affilée.
  4. Fixez-vous des objectifs et capturez des métriques.
  5. Les auteurs doivent annoter la source code avant le revoir .
  6. Utilisez des listes de contrôle.
  7. Établir un processus pour corriger les défauts trouvés.

De même, quand devriez-vous faire une revue de code ?

Quand revoir les revues de code devrait se produire après que les contrôles automatisés (tests, style, autre CI) se soient terminés avec succès, mais avant la code fusionne avec la branche principale du référentiel. Nous n'effectuons généralement pas de formalité revue de code des changements globaux depuis la dernière version.

De plus, comment Google effectue-t-il les revues de code ? Pour démontrer leur capacité à revoir le code pour plus de lisibilité, les développeurs de Google passer par un " revoir de leur revue de code les pratiques". Par conséquent, le développeur soumet code changements à une équipe d'experts en lisibilité. Ceux-ci inspecteront le code . Mais cette inspection n'est pas comme une normale revue de code.

La question est également: comment coder comme un examen humain ?

Technique

  1. Laissez les ordinateurs faire les parties ennuyeuses.
  2. Réglez les arguments de style avec un guide de style.
  3. Commencez à réviser immédiatement.
  4. Commencez à un niveau élevé et descendez.
  5. Soyez généreux avec les exemples de code.
  6. Ne jamais dire "vous"
  7. Cadrez les commentaires comme des demandes, pas des commandes.
  8. Liez les notes à des principes, pas à des opinions.

Qu'est-ce qu'une bonne revue de code ?

Bonnes critiques de code posez des questions ouvertes au lieu de faire des déclarations fortes ou opiniâtres. Ils offrent des alternatives et des solutions de contournement possibles qui pourraient mieux fonctionner pour la situation sans insister sur le fait que ces solutions sont les meilleur ou la seule façon de procéder.

Conseillé: