Pour un accès simple et rapide, vous pouvez désormais consulter les commentaires d’une revue de code depuis Atom dans un dock à côté de l’éditeur.

La revue de code est un processus social, émotionnel et logistique. Recevoir une pull request est un instant redouté pendant lequel on peut se sentir particulièrement vulnérable. Que pensent mes pairs de mon travail ? Au vu de ce feedback, quels points dois-je améliorer ? Comment m’assurer d’avoir répondu à tous les questions ?

Pour améliorer l’expérience de la revue de pull request, et vous permettre d’intégrer les commentaires à votre éditeur de texte de manière simple, voici les commentaires de revue sur Atom. Avec Atom 1.37 beta, vous pouvez consulter les commentaires des revues dans un dock situé à côté de l’éditeur. Ce dock assure une navigation fluide entre les commentaires et le code ou le texte, vous permettant ainsi d’effectuer des modifications en réponse au feedback reçu. Pour vous défaire du stress lié au fait d’avoir répondu, ou non, à tous les commentaires, vérifiez la barre de progression afin de savoir combien de commentaires non résolus il vous reste à traiter.

Dans les moindres détails

Nous avons également ajouté quelques fonctionnalités afin de vous aider à gérer les revues de code.

• Résolution des commentaires : marquez les discussions liées à une critique comme résolues dans le dock des commentaires. A chaque fois que vous répondez à un commentaire, la barre de progression avance, ce qui vous donne une indication visuelle ainsi qu’un sentiment de satisfaction parfaitement mérité, puisque vous vous rapprochez de votre objectif.
• Différentiel clair : le dock vous signale les lignes du différentiel qui précèdent et suivent le commentaire. Besoin de plus de contexte ? Cliquez sur le bouton Open Diff pour voir le différentiel sur la totalité de la pull request.
• Développement et réduction des commentaires : les fils de commentaires pouvant être très longs, nous souhaitions vous donner la possibilité de vous concentrer uniquement sur l’information la plus utile. Pour réduire la pollution visuelle, vous pouvez réduire ou développer les commentaires résumant la revue de code ou les fils de commentaires.
• Navigation entre les changements avec la sélection de ligne et les marqueurs : découvrez à quelle ligne de code ou de texte correspond un commentaire grâce à la sélection de ligne et aux marqueurs. Cliquer sur un marqueur permet également d’ouvrir le dock des revues de code et de faire défiler l’écran jusqu’au commentaire sélectionné. Veuillez noter qu’afin de voir les sélections et les marqueurs, vous devez être enregistrés sur le site de GitHub pour Atom, et vous trouver sur une branche vérifiée et correspondant à une pull request.
• Vérifier et rafraîchir : si les revues de code sont sur une autre branche que celle que vous avez vérifiée, vous pourrez toujours voir les commentaires mais vous ne pourrez pas vous rendre sur le fichier ni marquer les commentaires comme étant résolus. Pour vérifier une branche de pull request, utilisez le bouton « Checkout » situé en haut du dock des revues. Profitez-en pour cliquer sur l’icône Rafraîchir pour découvrir les nouveaux commentaires et revues.

Itérations de conception

Nos premières conceptions de la revue de code sur Atom nous ont donné l’impression de recréer GitHub.com dans un éditeur.

La disposition d’esprit est différente selon que l’on se trouve sur un navigateur ou sur un éditeur. Au fond, on utilise un éditeur pour éditer du code ou du texte. Nous avons donc adopté une approche différente de la revue de pull request et décidé de nous concentrer sur l’expérience de l’édition. Modifier du code par rapport à un long commentaire ou fil de discussion peut être perturbant ; nous avons décidé de créer un dock en regard du code ou du texte afin que vous puissiez l’afficher (ou le cacher) comme vous le souhaitez, plutôt que de faire des commentaires directement dans le code.

L’étape suivante a été la recherche d’utilisateurs pour valider nos conceptions de dock. Nous avons testé nos hypothèses afin de vérifier que les nouveaux concepts étaient compréhensibles et utiles. Les participants à l’étude étaient enthousiastes à l’idée d’utiliser une méthode destinée à traiter les commentaires de revue sans avoir à passer de GitHub.com à leur éditeur.

Les participants ont indiqué que le fait de pouvoir réagir aux commentaires via des smileys était un bon moyen de signifier aux auteurs comment leur feedback a été accueilli. Les réactions par smileys ont également été le moyen de dire « merci » ou « beau travail ». Les smileys permettent aussi d’émettre des sous-entendus, de donner un certain ton et d’aider les utilisateurs à communiquer de façon plus empathique.

De plus, le processus de réponses aux commentaires était plus important que ce à quoi nous nous attendions. En tant que créateurs de code, nos utilisateurs souhaitaient avoir la possibilité de demander s’ils étaient vraiment parvenus à répondre aux questions posées lors de la revue de code, plutôt que de faire des suppositions. En y réfléchissant, c’est plutôt logique : les revues de pull requests sont de véritables conversations. Nous avons donc pris en compte ce retour très utile et nous avons ajouté la fonctionnalité de réponse aux commentaires et les réactions par smileys.

Malheureusement, toute fonctionnalité à caractère social peut être utilisée de manière malveillante. Pour votre sécurité, le dock de commentaires cache les commentaires ayant été signalés par les utilisateurs GitHub comme abusifs ou indésirables. Pour réduire le risque de mauvaise utilisation, nous avons également demandé à notre équipe Communauté et Sécurité de vérifier cette fonctionnalité.

Prochaines étapes

Pour accéder aux commentaires de revue sur Atom, téléchargez Atom 1.37 Beta. Si vous souhaitez nous donner votre avis ou recevoir des informations quant aux prochaines étapes, consultez le dépôt Atom. Merci de votre attention, à vous d’éditer (et de passer du code en revue !).

 

Obtenez l’accès aux nouvelles fonctionnalités d’Atom en avant-première