<aside> 💡 Ce modèle documente notre façon de faire des revues de code. Il est utile pour les nouveaux employés et pour rester cohérent dans la durée.

</aside>

Philosophie

Pourquoi faire des revues de code ? Quels sont les principes à suivre pour ces revues ?

Vous pouvez mentionner d’autres pages comme les lignes directrices d’ingénierie. Pour faire un lien vers une autre page, tapez @ suivi du nom de la page : Lignes directrices d’ingénierie.

Préparation de la revue

La préparation permet de mettre les relecteurs dans les meilleures conditions.

Messages de commit

Assurez-vous que vos messages de commit soient descriptifs.

Descriptions des PR GitHub

La description de vos PR doivent être une extension de vos messages de commit. Écrivez à la fois ce que le commit change et comment vous avez implémenté le changement.

Revue de code en tant que telle

Comment relire

• Faites deux passages sur la PR si elle est grosse.
  • À la première relecture, cherchez à comprendre les changements apportés par ce code, en prenant une certaine hauteur.
  • À la seconde relecture, prêtez davantage d’attention aux détails sémantiques.

Exemples

var commentCount = 0;

Vous pourriez suggérer un let au lieu d’un var.