Revue de pull request
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.
Voyez-le en action
Fonctionnalités
Détecte les écarts aux règles de style et génère des commentaires de PR clairs et cohérents.Enrichit les descriptions de pull request avec le contexte pertinent de votre base de code et de votre documentation.Signale quand une documentation associée peut être obsolète en fonction des changements de code.Automatise les tâches de revue fastidieuses afin que les ingénieurs puissent se concentrer sur des travaux à plus fort impact.Maintient 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 service backend afin d'améliorer le signalement des erreurs et de réduire les journaux redondants dans les flux utilisateur. Elle introduit un utilitaire de journalisation 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 journalisation hérités de la couche de validation. Ces changements suivent notre norme de journalisation structurée et visent à améliorer la traçabilité entre les microservices.
Contexte/Jira: <span class="text-color-blue">fil Slack</span>
<hr/>
Commentaire sur la demande :
Voici ma première passe de revue réalisée par mon agent :
Les gestionnaires mis à jour sont propres et respectent notre guide de style actuel. Petit point à noter : 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
L'agent démarre lorsqu'un utilisateur saisit un lien de pull request.
Étape 2 : Récupérer le diff de la PR
À l'aide de l'API GitHub, l'agent récupère le diff pour comprendre les changements apportés à la pull request.
Étape 3 : Appliquer les guides de style
L'agent identifie les sections pertinentes du guide de style en fonction du diff du code et se prépare à vérifier les écarts.
Étape 4 : Analyser le code à la recherche de problèmes
L'agent examine le code pour détecter les écarts de style et les pistes d'amélioration.
Étape 5 : Générer des commentaires de PR
Il rédige des retours clairs et exploitables pour aider à améliorer la pull request.
Étape 6 : Publier les commentaires sur GitHub
À l'aide de l'API GitHub, l'agent ajoute directement des commentaires à la PR.
Étape 7 : Ajouter des informations contextuelles
L'agent recherche dans la base de code et les systèmes associés afin de recueillir un contexte utile.
Étape 8 : Réécrire la description de la PR
Il résume les changements dans un seul paragraphe et met automatiquement à jour la description de la PR.
Étape 9 : Vérifier l'impact sur la documentation
L'agent examine la documentation liée pour voir si des éléments doivent être mis à jour.
Étape 10 : Suggérer des modifications de la documentation
Si nécessaire, l'agent laisse dans la PR des commentaires contenant des recommandations précises de mise à jour de la documentation.
Work AI qui fonctionne.
