par Phil Miller
Dernièrement, chez Korbit, nous avons beaucoup écrit sur l'importance, les outils et les moyens d'améliorer la revue de code. Ce n'est pas un hasard. Nous pensons qu'il s'agit d'un point d'inflexion critique pour les organisations d'ingénierie. À tel point que nous avons conçu un produit entier autour de ce thème. Nous pensons également que Korbit AI Mentor est le moyen le plus simple d'intégrer des outils d'IA modernes dans votre flux de développement logiciel. Pensez-y comme à votre propre ingénieur senior à la demande.
Et comme tout ingénieur productif de votre équipe, ils sont là pour soutenir le reste de l'équipe et l'aider à se développer. Tout en contribuant à livrer des logiciels plus rapidement et avec une meilleure qualité. C'est pourquoi un mentor IA qui rejoint les processus existants est une mise à niveau si facile : dès le premier jour, il peut ajouter de la valeur avec une formation minimale et une perturbation minimale de l'équipe. Ils vivent dans les PR GitHub qui sont déjà une seconde nature pour votre équipe et ils évoluent au fur et à mesure que votre équipe (et votre base de code) grandit.
Partir sur de bonnes bases
Précédemment, nous avons vu comment améliorer les revues de code en général. Examinons quelques éléments spécifiques à GitHub pour les rendre encore meilleures.
Des descriptions efficaces à l'aide de markdown (et plus encore !)
Nous pourrions (et devrions probablement !) écrire un guide complet sur l'efficacité du markdown sur GitHub. Pour l'instant, passons en revue quelques incontournables pour écrire des descriptions efficaces en dehors du markdown standard que vous connaissez tous.
- Listes de tâches - Ces listes sont particulièrement utiles si votre RP est un projet. Elles donnent aux évaluateurs une indication clé de ce qu'il reste à faire afin qu'ils puissent ajuster leurs commentaires en conséquence.
- Actifs - Saviez-vous que vous pouviez glisser-déposer des fichiers dans votre description ? C'est le moyen idéal de partager une capture d'écran de l'interface utilisateur qui a été mise en œuvre, ou peut-être de demander un retour d'information.
- Mentions - @somebody (ou @someteam) et faites-leur savoir que vous appréciez leur contribution.
- Références - tapez # et vous obtiendrez une liste de problèmes ou de PRs suggérés !
- Alertes - pour les cas où vous avez vraiment besoin de signaler quelque chose d'important ⚠ ou de dangereux 💀
Réviseurs suggérés / Propriétaires de codes
Lorsque vous créez un PR, GitHub utilise les données `git blame` pour essayer de vous suggérer des évaluateurs. Cela peut être utile si vous êtes nouveau ou si vous avez du mal à vous rappeler qui pourrait être une bonne personne à étiqueter.
Une autre approche, plus structurée, consiste à utiliser les propriétaires de code. Cela vous permet de créer un fichier qui définit les règles pour savoir qui recevra automatiquement une demande de révision lorsqu'un PR est créé. Comme pour les mentions, vous pouvez étiqueter des individus ou des équipes et vous pouvez configurer ce fichier par branche, par type de fichier, par répertoire ou globalement.
Modifications suggérées, Modifications demandées
Et lorsque le moment est venu pour l'un de ces relecteurs d'entrer ses commentaires, une excellente façon de le faire est par le biais des modifications suggérées. Cela leur permet de suggérer (idéalement) de petites modifications que l'auteur du code peut valider individuellement ou par lot. Ce flux de travail a l'avantage de créditer toutes les personnes qui ont contribué à la PR, ce qui rendra également les git blames plus précis.
Utilisation des chèques
Un autre sujet qui mérite un article approfondi dans le futur est l'intégration continue (CI) en relation avec les demandes d'extraction (pull requests). Dans le cas de GitHub, il peut s'agir de suites de tests (par exemple, des tests unitaires) ou d'outils d'analyse statique (par exemple, le linting) qui s'exécutent via GitHub Actions. Ces contrôles sont typiquement un type de porte qui empêche un PR d'être fusionné et représenterait également une porte pour l'approbation de l'évaluateur.
L'avenir des RP avec Korbit AI Mentor
S'appuyant sur la base solide de tous les éléments ci-dessus, Korbit AI Mentor vous permet d'alléger encore plus la charge de travail de vos ingénieurs les plus demandés.
Notre mentor IA détectera les problèmes sur chaque RP. Cela inclut des éléments tels que les bogues critiques, les optimisations de performance, les vulnérabilités de sécurité et les écarts par rapport à vos normes de codage internes. La conversation se déroule dans le PR, toujours en contexte. Le mentor IA explique les problèmes et propose un code de remplacement. Il fournira également des liens vers des exercices de codage en direct afin d'aider vos ingénieurs à se perfectionner et d'éviter que le problème en question ne se reproduise.
Contrairement à d'autres outils d'IA "juste à temps", Korbit AI Mentor a un contexte persistant. Il s'améliorera avec le temps et vous pouvez affiner les types de problèmes qu'il fait apparaître via l'inhibition et le filtrage. Vous pouvez également exclure globalement des fichiers et des répertoires en utilisant un fichier `.korbitignore` dans votre répertoire.
En plus de l'examen automatisé de chaque PR, vous pouvez effectuer des analyses manuelles de vos dépôts. Ceci peut être accompli via votre tableau de bord Mentor ou via notre outil CLI. Ces analyses peuvent porter sur l'ensemble du dépôt (tous les fichiers) ou sur une branche spécifique (fichiers récemment modifiés). L'outil CLI permet également une intégration facile avec votre CI/CD (comme GitHub Actions!).
Au fur et à mesure que notre AI Mentor s'intègre dans votre organisation d'ingénierie, il vous fournira des informations précieuses sur la santé de l'équipe et de l'organisation. Suivez les problèmes et les analyses, et consultez les mesures clés pour tous vos ingénieurs. Il s'agit d'un outil précieux pour la planification de projets, l'établissement de calendriers et la budgétisation. Au lieu de deviner, vous pouvez maintenant prendre des décisions plus éclairées et travailler sur ce qui est le plus important.
Travailler main dans la main avec l'IA
Les outils d'IA tels que Korbit AI Mentor seront de plus en plus intégrés à la culture et aux processus d'ingénierie. L'important est de trouver un équilibre entre l'expertise humaine et le mentorat de l'IA. Ces outils existent pour rendre vos ingénieurs plus productifs, et non pour les remplacer. Il est essentiel pour votre réussite opérationnelle que vos ingénieurs soient bien formés à la manière de travailler avec l'IA, en particulier les ingénieurs en début de carrière. Plus vous pourrez adapter vos outils d'IA à vos besoins spécifiques, plus ils (et vous) seront productifs.
Si vous utilisez GitHub aujourd'hui et que vous souhaitez un mentor IA à la demande qui rendra votre organisation d'ingénierie plus productive, fournira un apprentissage continu, des informations précieuses et évoluera avec votre équipe, vous vous devez d'essayer Korbit AI Mentor. Ensuite, faites-nous savoir ce que vous en pensez, nous apprécions votre contribution !
Article précédent sur l'accélération des revues de code de votre équipe avec Korbit.
.png)
