Que fait review-pr ?
Examinez le diff d'une pull request et rédigez un feedback structuré dans review.json pour que le workflow le publie. À utiliser pour examiner une PR extraite localement à partir d'artefacts comme pr_diff.txt et pr_description.txt, en produisant une sortie de révision lisible par machine au lieu de publier directement sur GitHub.
Comportement
- Vérifie que le fichier
pr_diff.txtexiste. - Examine le diff et la description de la PR pour détecter des problèmes et suggérer des améliorations.
- Génère un fichier
review.jsonavec un feedback structuré.
Format de sortie
{
"summary": "Résumé global de la révision",
"issues": [
{
"id": "unique-issue-id",
"type": "problem" | "suggestion",
"severity": "critical" | "major" | "minor" | "info",
"file": "chemin/vers/le/fichier",
"line": 42,
"title": "Titre concis du problème",
"description": "Description détaillée...",
"suggestion": "Correction ou amélioration suggérée..."
}
]
}
Catégories
- Sécurité : vulnérabilités, XSS, injection, fuites de données, dépendances non sécurisées.
- Bugs : erreurs logiques, conditions limites, erreurs de type, concurrence, cas exceptionnels.
- Performance : goulots d'étranglement, consommation mémoire, requêtes N+1, complexité.
- Qualité du code : maintenabilité, lisibilité, duplication, cohérence du style.
- Architecture : séparation des responsabilités, couplage, cohésion, principes SOLID.
- Tests : couverture, cas aux limites, tests d'intégration, qualité des assertions.
- Documentation : clarté, exhaustivité, exactitude des commentaires et de la documentation.
- Général : tout autre problème ou suggestion pertinent.
Artefacts d'entrée
pr_diff.txt: Le diff complet de la PR.pr_description.txt: La description de la PR (facultatif).context/: Répertoire contenant le code source à examiner (le répertoire de travail est la racine du dépôt).
Artefact de sortie
review.json: Feedback structuré de la révision.
Support de plateforme
Ce skill fonctionne avec les PRs GitHub et GitLab. Il nécessite que la PR soit extraite localement avec pr_diff.txt et pr_description.txt disponibles.
Consignes
- Effectuez une révision approfondie et complète.
- Fournissez des numéros de ligne exacts et des suggestions spécifiques.
- Priorisez les problèmes critiques et majeurs dans le résumé.
- Utilisez des catégories appropriées pour chaque problème.
- Pour les modifications importantes, concentrez-vous sur les fichiers les plus impactés.
- En cas de doute, préférez un excès de détails plutôt qu'une omission.