Lorsque vous créez une pull request, vous demandez à d’autres personnes d’examiner vos modifications et de faire part de leurs commentaires. Les demandes de tirage qui sont ciblées, claires et faciles à suivre aident les réviseurs à donner de meilleurs commentaires et à faire des suggestions confiantes.
Faciliter la révision de vos modifications
Le contexte clair aide les réviseurs à comprendre rapidement ce qui a changé et pourquoi il importe. Elle réduit les modifications, accélère la révision et aide votre équipe à se concentrer sur les parties les plus importantes du changement.
Écrire de petites pull requests
Les pull requests de petite taille et ciblées sont plus faciles à examiner et moins risquées à fusionner. Ils aident les réviseurs à comprendre l’objectif du changement, à repérer les problèmes plus rapidement et à suivre l’historique du projet ultérieurement.
Lorsqu’une modification devient importante, envisagez de la scinder en pull requests plus petites, ayant chacune un seul objectif.
Fournir un contexte et des conseils
Un titre et une description clairs aident les réviseurs à comprendre le problème, l’approche et le résultat. Un bon contexte explique souvent pourquoi le changement est nécessaire, ce qui a changé et où les réviseurs doivent prêter une attention particulière.
Des indications sont particulièrement utiles lorsqu’une pull request concerne de nombreux fichiers ou nécessite un ordre de révision spécifique. Par exemple, vous pouvez pointer les réviseurs vers les fichiers les plus importants en premier ou expliquer le type de commentaires le plus utile. Vous pouvez également utiliser GitHub Copilot pour générer un résumé de votre pull request.
Vérifiez votre propre pull request en priorité
Passer en revue votre propre demande de tirage avant de demander à d’autres personnes de l’examiner vous aide à détecter les erreurs tôt. Cela indique également aux relecteurs que la pull request est prête à être examinée.
Une auto-révision peut inclure la lecture de la différence, la vérification des modifications accidentelles et la vérification de l’exécution des builds ou des tests pertinents.
Vérifier la sécurité
Les examens de sécurité permettent de détecter les risques avant la fusion d’une pull request. C’est particulièrement important lorsqu’une pull request modifie les dépendances, l’authentification, les autorisations, les flux de travail ou le code qui traite des données sensibles.
GitHub peut afficher des informations de sécurité dans les pull requests, telles que les modifications des dépendances, les résultats de l’examen des dépendances et les vérifications code scanning. Utilisez ces signaux pour résoudre les problèmes au début ou pour mettre en évidence les risques qui nécessitent une attention de réviseur.
Si votre référentiel a code scanning configuré comme contrôle, GitHub Copilot fixation automatique peut suggérer des correctifs pour les vulnérabilités de sécurité.
Tenir votre équipe informée
Les pull requests ne servent pas seulement à documenter les modifications du code : elles permettent aussi de tenir votre équipe informée de l’état d’avancement de votre travail. La progression visible permet de réduire les mises à jour d’état distinctes et de maintenir tout le monde aligné.
Utiliser GitHub Copilot pour générer des résumés de pull request
Remarque
Copilot les fonctionnalités nécessitent un forfait Copilot. Consultez « Plans de GitHub Copilot ».
Copilot peut générer un résumé de pull request sur GitHub. Un résumé généré peut aider les réviseurs à comprendre les principales modifications, mais vous devez l’examiner attentivement et ajouter un contexte que vous connaissez uniquement.
Les résumés sont les plus utiles lorsqu’ils expliquent l’objectif du changement, appellent des fichiers importants et mettent en évidence tout ce que les réviseurs doivent examiner attentivement.
Lien vers des problèmes ou des projets connexes
La connexion d’une demande de tirage (pull request) à des problèmes ou à des projets montre comment le travail s’intègre dans le projet plus grand. Les liens aident les réviseurs à comprendre la priorité, à suivre la progression et à trouver les discussions associées.
Utilisez des mots-clés de clôture lorsqu’une pull request doit fermer une issue une fois fusionnée. Vous pouvez également ajouter un lien vers Projects afin que chacun puisse suivre le travail au même endroit.
Mettez en surbrillance le statut avec des étiquettes
Les étiquettes d’état aident les réviseurs à comprendre si une demande de tirage est prête à être examinée, bloquée ou toujours en cours. Les étiquettes claires facilitent la hiérarchisation des révisions et évitent d’examiner le travail avant qu’elles ne sont prêtes.