Examiner les pull requests GitHub avec Codex

Utilisez la revue de code Codex pour bénéficier d’une nouvelle passe de revue à forte valeur ajoutée sur les pull requests GitHub. Codex examine le diff de la pull request, suit les consignes de votre dépôt et publie une revue de code GitHub standard axée sur les problèmes graves. Security Review, disponible en version préliminaire de recherche, fournit un examen plus approfondi des problèmes de sécurité potentiels d’une pull request.

Regarder : présentation de la revue de code Codex

Avant de commencer

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

• Codex cloud est configuré pour le dépôt que vous souhaitez examiner.
• Vous avez accès aux paramètres de revue de code 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 Codex

Pour configurer les revues automatiques, vous devez disposer d’un dépôt GitHub connecté et d’une autorisation GitHub de push ou d’administration pour ses paramètres.

1. Configurez Codex cloud.
2. Accédez aux paramètres Codex.
3. Activez Code review pour votre dépôt.

Demander une revue à Codex

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

Codex publie une revue sur la pull request, comme le ferait un membre de votre équipe. Dans GitHub, Codex signale uniquement les problèmes P0 et P1 afin que les commentaires de revue restent centrés sur les risques hautement prioritaires.

Activer les revues automatiques

Si vous souhaitez que Codex examine automatiquement chaque pull request, activez Revues automatiques dans les paramètres Codex. Codex publiera une revue chaque fois qu’une personne ouvrira une nouvelle PR pour examen, sans qu’un commentaire @codex review soit nécessaire.

Personnaliser ce que Codex examine

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 dans le fichier le plus proche du code auquel les règles s’appliquent. Utilisez des titres ### pour regrouper les vérifications associées lorsque cela est utile.

Par exemple, un service de rapport d’expériences peut empêcher le comportement post-exposition de modifier une cohorte de comparaison :

## Code Review Rules

### Experiment cohorts

- Do not filter treatment comparisons on post-exposure behavior, including conversion or retention.
  Safe path: build cohorts from assignment or exposure; report conversion as an outcome.

Placez les règles applicables à l’ensemble du dépôt dans le fichier AGENTS.md à la racine et les règles propres à un service dans un fichier imbriqué, tel que services/experiment_reporting/AGENTS.md. Codex applique les consignes de la racine ainsi que les consignes plus spécifiques couvrant chaque fichier modifié, afin que les modifications sans rapport n’aient pas à inclure le contexte propre au service.

Commencez par deux ou trois règles concises qui formalisent les vérifications souvent expliquées par les personnes chargées des revues. Règles utiles :

• Concentrez-vous sur les comportements importants et propres au dépôt. Décrivez la contrainte de compatibilité, la limite des données ou l’effet secondaire dangereux à signaler, ainsi que son importance.
• Indiquez la procédure sûre ou l’exception. Donnez à Codex suffisamment de contexte pour distinguer un véritable problème d’un comportement attendu.
• Définissez des règles ciblées et durables. Privilégiez les résultats attendus plutôt que les noms de fonctions susceptibles de changer, et placez les consignes à proximité du code auquel elles s’appliquent.
• Réservez les vérifications mécaniques à la CI. N’incluez pas la mise en forme, le linting ni les autres vérifications déterministes dans les règles de revue.

Ouvrez une pull request représentative et demandez une revue avec @codex review. Affinez les règles selon les constats et les retours obtenus, puis limitez ou supprimez les consignes qui génèrent du bruit.

Les règles de revue de code guident Codex ; elles ne remplacent pas les tests, les protections de branches ni les approbations obligatoires.

Pour une demande ponctuelle, ajoutez-la au commentaire de votre pull request :

@codex review for issues in the database migration

Security Review

Security Review est une revue supplémentaire destinée aux clients qui souhaitent accorder une attention particulière aux problèmes de sécurité dans les pull requests. Elle examine plus en profondeur que Code Review les risques propres à la sécurité en analysant le diff de la pull request, le contexte pertinent du dépôt ainsi que les modèles de menaces ou les consignes de sécurité configurés.

Code Review peut également détecter des problèmes liés à la sécurité dans le cadre de sa revue générale. Il peut donc arriver que les constats de Code Review et de Security Review se recoupent.

Configurer Security Review

Pour obtenir des instructions de configuration et des options plus détaillées, consultez Security Review.

1. Configurez Codex cloud.
2. Accédez aux paramètres de Codex.
3. Sous Repository preferences, choisissez quelles pull requests font l’objet d’une Security Review et quand elle s’exécute. Sélectionnez Whenever code review runs pour l’exécuter en même temps que Code Review.

Demander une Security Review

Pour demander manuellement une Security Review, ajoutez ce commentaire à une pull request :

@codex security review

Codex réagit pendant l’exécution de la revue, puis publie les constats de sécurité directement sur la pull request. Ouvrez la tâche Codex associée et sélectionnez l’onglet Security Report pour afficher le rapport complet.

Traiter les constats de la revue

Une fois que Codex a publié une revue, vous pouvez lui demander de corriger les problèmes dans la même pull request en laissant un autre commentaire :

@codex fix the P1 issue

Codex démarre une conversation cloud avec la pull request comme contexte et peut envoyer une correction sur la branche lorsqu’il dispose des autorisations nécessaires.

Confier d’autres tâches à Codex

Si vous mentionnez @codex dans un commentaire contenant autre chose que review, Codex démarre une conversation cloud en utilisant votre pull request comme contexte.

@codex fix the CI failures

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é Revue de code pour le dépôt dans les paramètres Codex.
• Vérifiez que la pull request appartient à un dépôt pour lequel Codex cloud est configuré.
• Utilisez le déclencheur exact @codex review dans un commentaire de pull request.
• Pour les revues automatiques, vérifiez que vous avez activé Revues automatiques et que l’événement de la pull request correspond aux paramètres de déclenchement de vos revues.