Revue de pull requests
Rationalisez les revues de code avec des retours automatisés, du contexte et une documentation alignée.
Aperçu
L'agent de revue de pull request automatise le processus de revue de PR de bout en bout, garantissant la qualité du code, la cohérence et une documentation à jour. Il détecte les écarts aux règles de style, enrichit les descriptions de PR avec le contexte pertinent et signale la documentation susceptible de devoir être mise à jour.
Découvrez-le en action
Fonctionnalités
Détecte les violations des guides de style et génère des commentaires de PR clairs et cohérents. Enrichit les descriptions des pull requests avec un contexte pertinent issu de votre code et de votre documentation. Signale lorsque la documentation associée pourrait être obsolète en fonction des modifications du code. Automatise les tâches de revue fastidieuses pour permettre aux ingénieurs de se concentrer sur un travail à plus forte valeur ajoutée. Assure la cohérence et la qualité entre les équipes grâce à des retours de revue standardisés.
Exemple de résultat
Mettre à jour la description d'une pull request :
Description interne pour les relecteurs :
Cette pull request met à jour deux gestionnaires de services backend afin d'améliorer la remontée des erreurs et de réduire les logs redondants dans les workflows utilisateur. Elle introduit un utilitaire de logging partagé, met à jour le schéma des messages d'erreur pour inclure l'horodatage et le contexte de la requête, et supprime les appels de logging hérités de la couche de validation. Ces modifications respectent notre norme de logging structuré et visent à améliorer la traçabilité entre les microservices.
Contexte/Jira : <span class="text-color-blue">Fil Slack</span>
<hr/>
Commentaire sur la requête :
Voici la première relecture effectuée par mon agent :
Les gestionnaires mis à jour sont clairs et respectent notre guide de style actuel. Une petite remarque : envisagez de renommer logEventData en quelque chose de plus spécifique, comme logValidationError, afin d'améliorer la clarté pour les futurs lecteurs.
Workflow de l'agent
Étape 1 : Déclenchement de l'activation
L'agent démarre lorsqu'un utilisateur saisit le lien d'une pull request.
Étape 2 : Récupération du diff de la PR
À l'aide de l'API GitHub, l'agent récupère le diff pour comprendre les modifications apportées dans la pull request.
Étape 3 : Application des guides de style
L'agent identifie les sections pertinentes du guide de style en fonction du diff du code et se prépare à détecter les infractions.
Étape 4 : Analyse du code à la recherche de problèmes
L'agent examine le code pour repérer les infractions au style et les opportunités d'amélioration.
Étape 5 : Génération de commentaires de PR
Il rédige des retours clairs et exploitables pour aider à améliorer la pull request.
Étape 6 : Publication des commentaires sur GitHub
À l'aide de l'API GitHub, l'agent ajoute directement les commentaires à la PR.
Étape 7 : Ajout d'informations contextuelles
L'agent explore la base de code et les systèmes associés pour rassembler un contexte utile.
Étape 8 : Réécriture de la description de la PR
Il résume les modifications en un seul paragraphe et met automatiquement à jour la description de la PR.
Étape 9 : Analyse de l'impact sur la documentation
L'agent examine la documentation connectée pour déterminer si des éléments doivent être mis à jour.
Étape 10 : Suggestion de modifications de la documentation
Si nécessaire, l'agent laisse des commentaires dans la PR avec des recommandations précises de mise à jour de la documentation.
Une IA de travail qui fonctionne.
