🎯 Intention

Dans ce standard, on souhaite expliciter la manière d’utiliser rubycritic et interpréter les résultats obtenus.

<aside> ✅ Pré-requis

• Avoir Rubycritic sur le projet </aside>

✅ Points clés

<aside> ⌛ Temps indicatif : ~ 30mn

</aside>

Lancer Rubycritic

• Pour lancer Rubycritic en local, il faut d’abord ajouter et commit ses changements

git add fichiers_a_ajouter && git commit -m 'Message de commit'

Raison :

Rubycritic va comparer la branche main avec la branche en cours. Du coup, il va changer de branche pendant qu’il tourne, il faut donc que les fichiers soient bien ajoutés sur la branche en question.

Analyses dans le browser

• Une page va s’ouvrir dans le browser avec 3 onglets dans la navbar:
  • main
  • nom-de-la-branche
  • Build

Chaque onglet donnera le score respectif et des notes de A à F.

• Cliquer sur un onglet puis sur Code pour avoir plus de détail:

  • churn: les changements apportés au fichier
  • complexity: la complexité du fichier — plus le score est élevé plus il est complexe
  • duplication: le nombre de duplications présentes dans le fichier
  • smells: les mauvaises pratiques présentes dans le fichier

• Cliquer sur un fichier pour avoir plus détails.

On va pouvoir mettre des choses en places obtenir une meilleur note:

• Simplifier la complexité du code produit
• Simplifier une autre partie du code lorsque l’on ne parvient plus à simplifier notre propre code.

Voici qq tips pour améliorer la note:

• réduire la taille des méthodes / fichier
• refactorer notre code de manière plus simple
• déplacer des logiques pour éviter de surcharger la class où l’on se trouve par exemple.

❌ Erreurs type à éviter

• Râler comme clément parce qu’on est pressé de faire passer notre pr

🎓Aller plus loin

Exemple de question qu’on se pose souvent ?