Les 10 commandements de la revue de code

Pour l’auteur

  1. Vous devez créer une merge request unitaire. 🔢 Votre merge request doit introduire un seul changement et rester d’une taille raisonnable.
  2. Vous devez décrire ce que fait votre code de manière globale. ✏️ Donnez suffisamment de contexte et d’éléments au relecteur pour qu’il comprenne ce que vous cherchez à accomplir.
  3. Vous devez assigner plusieurs relecteurs. 👪 Plus vous avez de relecteurs, plus de bugs pourront être détectés.
  4. Vous devez répondre à toutes les remarques des relecteurs. ✅ Toutes les remarques ont leur importance et doivent être traitées. En répondant, gardez à l’esprit que rien n’est évident pour l’interlocuteur.
  5. Ne prenez pas les choses personnellement. ❤️ C’est toujours bénéfique pour une équipe de confronter les idées.

Pour le relecteur

  1. Vous devez faire des revues de code tous les jours. ⏰ La revue de code favorise la communication et le partage des connaissances.
  2. Vous devez lire la description de la merge request avant de passer au code. 📖 Commencez par comprendre ce que l’auteur cherche à changer, puis vérifiez si le changement est correctement implémenté.
  3. Vous devez être précis et utiliser des phrases complètes. 🔊 L’auteur ne doit pas deviner ce que vous essayez de dire. En faisant des remarques, gardez à l’esprit que rien n’est évident pour l’interlocuteur.
  4. Vous devez être bienveillant. 👼 «Cette variable doit être renommée userId» vs «Que diriez-vous de renommer cette variable pour être cohérent avec les autres variables ?»
  5. Vous devez appliquer la règle OIS. 📏 Observer - Impact - Suggérer. Observer : «Cette méthode contient 100 lignes». Impact : «Il m’est difficile d’en comprendre la logique». Suggest : «Vous pouvez l’extraire en 2 méthodes avec des noms explicites».