Examiner les pull requests GitHub avec Codex

Utilisez la revue de code de Codex pour obtenir un avis supplémentaire ciblé sur les problèmes importants dans vos pull requests GitHub. Codex examine les modifications de la pull request, suit les consignes de votre dépôt et publie une revue de code au format habituel de GitHub qui signale les problèmes graves. La revue de sécurité, disponible en version préliminaire de recherche, examine plus en détail les problèmes de sécurité potentiels d’une pull request.

Avant de commencer

Vérifiez que vous disposez des éléments suivants :

• Un dépôt GitHub connecté à Codex. Pour configurer l’ancienne intégration, consultez Codex Cloud (ancienne version).
• Un accès aux paramètres de revue de code de Codex.
• Un fichier AGENTS.md si vous souhaitez que Codex suive des consignes de revue propres au dépôt.

Configurer la revue de code de Codex

Pour configurer les revues automatiques, vous devez disposer d’un dépôt GitHub connecté à Codex et de droits d’écriture ou d’administration sur ce dépôt dans GitHub.

1. Connectez votre dépôt GitHub à Codex.
2. Ouvrez les paramètres de Codex.
3. Sélectionnez votre dépôt, puis activez Revue automatique dans la section Examiner le code.

Demander une revue à Codex

1. Dans un commentaire de la pull request, saisissez @codex review.
2. Attendez que Codex réagisse (👀) et publie sa revue.

dkundel-openaicommented21 minutes agoAuthor

@codex review

Codex publie sa revue sur la pull request, comme le ferait un membre de votre équipe. Sur GitHub, Codex signale uniquement les problèmes de niveau P0 ou P1 afin que les commentaires de revue portent sur les risques prioritaires.

Activer les revues automatiques

Pour activer les revues automatiques de vos pull requests, activez Revue automatique sous Préférences personnelles dans les paramètres de Codex. Choisissez quand lancer les revues avec Déclencheur de revue. Ce réglage s’applique aux dépôts pour lesquels la revue de code est activée. Vous n’avez pas besoin d’ajouter de commentaire @codex review.

Personnaliser les vérifications de Codex

Codex recherche les fichiers AGENTS.md dans votre dépôt et suit les règles de revue de code applicables. Ajoutez une section ## Code Review Rules au fichier le plus proche du code concerné. Utilisez des titres de niveau ### pour regrouper les vérifications connexes si nécessaire.

Par exemple, un service qui produit des rapports d’expérimentation peut appliquer cette règle pour éviter que les comportements observés après l’exposition ne modifient la composition des cohortes comparées :

## Code Review Rules

### Cohortes expérimentales

- Lorsque vous comparez les traitements, ne filtrez pas les participants selon leur comportement après l’exposition, y compris la conversion ou la rétention.
  Constituez les cohortes à partir de l’affectation aux groupes ou de l’exposition au traitement. Présentez la conversion comme un résultat.

Placez les règles communes à tout le dépôt dans le fichier AGENTS.md à la racine et les règles propres à un service dans un fichier de son arborescence, par exemple services/experiment_reporting/AGENTS.md. Pour chaque fichier modifié, Codex applique les consignes définies à la racine ainsi que les consignes plus précises qui le concernent. Les modifications sans rapport avec le service peuvent ainsi être examinées sans son contexte particulier.

Commencez par deux ou trois règles concises qui décrivent les vérifications que votre équipe doit souvent expliquer lors des revues. Pour rédiger des règles utiles :

• Ciblez les comportements propres au dépôt qui ont des conséquences importantes. Précisez quelle contrainte de compatibilité doit être respectée, quelle limite s’applique aux données ou quel effet de bord dangereux doit être signalé. Expliquez pourquoi.
• Indiquez la marche à suivre ou l’exception prévue. Donnez à Codex suffisamment de contexte pour distinguer un véritable problème d’un comportement attendu.
• Rédigez des règles ciblées et durables. Décrivez le résultat attendu plutôt que de citer des noms de fonctions susceptibles de changer. Placez les consignes à proximité du code concerné.
• Confiez les vérifications systématiques à la CI. Laissez le contrôle du formatage, l’analyse par un linter et les autres vérifications déterministes en dehors des règles de revue.

Ouvrez une pull request représentative et demandez une revue avec @codex review. Affinez les règles en fonction des problèmes signalés et des retours reçus. Précisez ou supprimez les consignes qui génèrent des signalements inutiles.

Les règles de revue de code guident Codex. Elles ne remplacent ni les tests, ni les protections de branche, ni les approbations requises.

Pour demander une vérification ponctuelle, précisez le point à examiner dans votre commentaire sur la pull request :

@codex review vérifiez si la migration de la base de données présente des problèmes

Revue de sécurité

La revue de sécurité est une revue complémentaire destinée aux clients qui souhaitent accorder une attention particulière aux problèmes de sécurité dans leurs pull requests. Elle examine les risques de sécurité plus en profondeur que la revue de code en analysant les modifications de la pull request, le contexte pertinent du dépôt et les modèles de menace ou les consignes de sécurité que vous avez configurés.

La revue de code peut également détecter des problèmes de sécurité lors de son examen général. Il arrive donc que les deux revues signalent les mêmes problèmes.

Configurer la revue de sécurité

Pour obtenir des instructions de configuration détaillées et connaître les options disponibles, consultez la page Revue de sécurité.

1. Connectez votre dépôt GitHub à Codex.
2. Ouvrez les paramètres de Codex.
3. Sélectionnez votre dépôt. Sous Examiner les vulnérabilités de sécurité, activez Revue de sécurité automatique, puis utilisez Examiner pour choisir les personnes dont les pull requests feront l’objet d’une revue. Réglez Déclencheur sur À chaque revue de code pour lancer les deux revues en même temps.

Demander une revue de sécurité

Pour demander manuellement une revue de sécurité, ajoutez ce commentaire à une pull request :

@codex security review

Codex ajoute une réaction pendant la revue, puis signale les problèmes de sécurité directement sur la pull request. Ouvrez la tâche Codex associée et sélectionnez l’onglet Rapport de sécurité pour consulter le rapport complet.

Résoudre les problèmes de revue de code

Si Codex ne réagit pas ou ne publie pas de revue :

• Vérifiez que vous avez activé la revue de code pour le dépôt dans les paramètres de Codex.
• Vérifiez que la pull request appartient à un dépôt GitHub connecté à Codex.
• Saisissez exactement @codex review dans un commentaire de la pull request.
• Pour les revues automatiques, vérifiez l’option Revue automatique dans les paramètres du dépôt ainsi que sous Préférences personnelles dans les paramètres de Codex. Vérifiez que l’événement survenu sur la pull request correspond au déclencheur de revue que vous avez configuré.