Les pull requests non révisées peuvent introduire des bugs et des incohérences dans le code.
Cela peut entraîner des problèmes de maintenance, augmenter les coûts de développement et nuire à la collaboration en équipe.
Cet article explore comment une revue de code efficace peut résoudre ces problèmes et renforcer la qualité du code.
Devenez expert en gestion de dépôts et automatisez avec GitHub Actions!
Une fois une pull request créée, il est essentiel de procéder à une revue de code avant d’intégrer les modifications à la branche principale. La revue de code joue également un rôle clé en améliorant la lisibilité du code, en favorisant le partage des connaissances au sein de l’équipe, et en assurant le maintien de normes de codage élevées.
Avant de participer à la revue de code, le reviewer doit normalement recevoir une notification par e-mail de pull request , comme expliqué précédemment. Cependant, dans notre repository où un seul compte est utilisé, nous participerons directement à la revue de code sans notification préalable.
Pour ce faire, accédez à votre pull request et cliquez ensuite sur » Files changed « .
Nous voilà sur notre code, où nous pouvons apporter des modifications ou proposer des ajustements en cliquant sur les icônes « + » et en laissant nos suggestions. Passons maintenant quelques exemples :
Après avoir cliqué sur la ligne 3, nous avons ajouté notre commentaire conformément aux règles établies, par exemple. Ensuite, cliquons sur « Start a review » pour commencer la revue.
La revue est en attente. Il est important de noter que nous pouvons ajouter plusieurs commentaires. Ensuite, pour finaliser la revue, cliquons sur « Finish your review ». Nous aurons alors la possibilité de laisser un commentaire global pour toutes les observations, puis d’envoyer la revue.
Pour terminer la revue, cliquons sur « Finish your review » et ajoutons un commentaire global si nécessaire. Notons que nous ne pouvons pas approuver la revue car nous sommes le créateur de celle-ci. Enfin, envoyons la revue en cliquant sur Submit review ; le créateur de la pull request recevra une notification de nos commentaires.
Ensuite, Il peut repondre le commentaire s’il n’est pas d’accord avec la proposition ou valider la proposition.
Dans le cas ou on a validé la proposition, nous allons merger la pull requests et on aura une notification comme ceci.
Super, nous avons terminé avec succès la procédure pour effectuer des revues de code avec des pull requests.
Formez-vous gratuitement avec Alphorm !
Maîtrisez les compétences clés en IT grâce à nos formations gratuites et accélérez votre carrière dès aujourd'hui.
FAQ
Comment effectuer une revue de code pour une pull request ?
Pourquoi la revue de code est-elle importante ?
Quels sont les avantages de commenter pendant une revue de code ?
Comment gérer les désaccords lors d'une revue de code ?
Que se passe-t-il après l'approbation d'une revue de code ?
Conclusion
La revue de code est essentielle pour maintenir des normes élevées et encourager le travail d’équipe. Quel aspect de la revue de code trouvez-vous le plus bénéfique pour votre équipe ?