Bonjour, Habr! Je vous présente la traduction de l' article «6 conseils pour une revue de code réussie» .
La révision du code a toujours été la pratique fondamentale de la création d'un code propre et maintenable.
Souvent, les développeurs négligent et sous-estiment la révision du code pour des raisons qui semblent objectivement correctes à ce moment-là.
Formulons aujourd'hui 6 conseils pour mener une révision de code de qualité et fructueuse .
I - Choisissez le bon moment
L'examen du code commence par choisir le bon moment .
Essayons de décrire ses caractéristiques:
- Faible chance d'être interrompu : vous devez éviter les heures de travail, au cours desquelles, selon l'expérience, les gens ont tendance à se distraire du processus de travail. En effet, certains jours ont souvent des périodes plus calmes, et juste à ces moments, il vaut la peine de planifier une révision du code.
- Un esprit propre et clair : vous ne devriez pas ressentir de stress avant le début de l'examen et dans le processus, par exemple, craindre une prochaine réunion avec le client. De plus, le programmeur dont le code doit être vérifié doit être dans un état calme afin qu'il n'y ait pas de tension entre vous qui puisse détruire le processus de révision du code.
- Le développeur garantit que le code est prêt pour la vérification : inutile de perdre du temps à regarder ce qui n'est pas encore prêt. Par préparation, on entend que le code fonctionne, sans mauvaise pratique, documenté et au moins couvert par des tests unitaires. D'après l'expérience, si un développeur lui-même consacre du temps à une révision de code, il est plus susceptible de donner un code de vérification pour lequel il n'a pas honte.
II - Fixer les limites
Il est utile de comprendre à l'avance la prochaine échelle de révision du code.
Envisagez une ou plusieurs fonctionnalités? Compte tenu du temps, est-il sensé d'en trop penser?
En règle générale, je veux me concentrer sur un nombre limité de changements afin de mieux comprendre de quoi il s'agit, et de ne pas sauter trop souvent entre les morceaux de code.
Pour définir correctement les limites de la tâche, vous pouvez:
- Effectuez les tâches assignées d'une taille visible . Pour ce faire, divisez les grandes tâches en petites et atomiques, par exemple, dans Jira ou même sur le tableau Scrum classique.
- Prioriser correctement la validation du code : si trop de tâches attendent d'être vérifiées, vous ne pourrez pas tout voir. Choisissez la priorité.
III - Créer la bonne atmosphère
Avant de commencer une révision de code, établissez une atmosphère favorable autour de vous.
Que faut-il pour cela?
- Nombre minimum de sons parasites: vous serez plus productif s'il y a le moins de bruit possible autour. Après tout, plus il est petit, meilleure est la concentration.
- Il n'y a pas de zone «d'interruption» : semblable à ce qui a été décrit dans la première partie, il convient d'éviter les moments où ils peuvent se détacher du processus. Il est plus facile de le faire dans une pièce séparée.
- Zone de critique positive : critiquer le travail de quelqu'un d'autre est un processus complexe. Mais c'est encore plus difficile à faire quand il y a beaucoup de monde autour. Dans une pièce fermée, vous pouvez parler librement sans craindre d'être écouté.
IV - Chat, chat et chat à nouveau
La vérification du code n'est pas un processus à sens unique.
Une révision de code réussie dépend fortement de la capacité de communiquer avec respect et efficacité avec un collègue. Après tout, non seulement l'inspecteur déclare ce qui est bien et ce qui ne l'est pas.
La révision du code est une conversation sur tout: portée, intentions, corrections et même désaccords.
Dans le processus, essayez d'adhérer aux recommandations suivantes:
- Non seulement écouter, mais entendre : les opinions et les opinions diffèrent souvent, et chaque désaccord doit donner lieu à une discussion constructive sur la question. Chaque point de vue a besoin d'attention.
- Ton neutre : vérifier le code n'est pas un examen ou l'Inquisition. Donnez l'impression que vous êtes venu pour juger le code, pas la personne qui l'a écrit.
- Doutes tourmente - précisez : si vous n'êtes pas sûr des détails d'implémentation spécifiques, renseignez-vous à ce sujet. Certaines intentions qui ne sont pas évidentes à première vue donnent souvent lieu à des interprétations erronées à l'avenir.
V - N'oubliez pas le but ultime
La révision du code doit conduire au résultat final : il peut s'agir de critiques constructives et de conseils pour améliorer ou intégrer le code avec les branches de développement correspondantes sélectionnées dans gitflow.
C'est la responsabilité de l'examinateur.
Mais comment jugez-vous si le code peut être intégré?
Voici quelques critères pour aider à la décision:
- Le code écrit résout le problème décrit dans l'instruction.
- Le code est correctement couvert par les tests unitaires .
- Conflits de fusion correctement résolus.
- Il n'y a aucun signe évident d' odeur de code ou de mauvaises pratiques .
VI - Utiliser des outils spéciaux
Il existe des outils pour une vérification facile du code. Vous pouvez les utiliser sans hésitation pour simplifier le processus de révision et d'intégration du code.
Trois marques dominent le marché des logiciels de vérification de code: Smartbear (avec Collaborator) , Perforce (avec Helix Swarm) et Atlassian (avec Crucible)
Ces outils fournissent souvent des outils complets pour organiser la révision du code, ainsi que des mesures pour maintenir votre équipe en constante amélioration.
C'est bien plus que des outils de comparaison de code, et ils s'intègrent à presque tous les systèmes de contrôle de version disponibles.
Essayez-le!
A vous de partager!
Si vous avez des conseils supplémentaires ou des exemples spécifiques qui vous sont arrivés dans la vie quotidienne des développeurs, partagez-les dans les commentaires.