Aider les autres utilisateurs à passer en revue vos modifications

Lorsque vous créez une demande de tirage, vous demandez à votre équipe d’examiner vos modifications et de vous faire part de ses commentaires. Ce guide présente les meilleures pratiques permettant de créer des demandes de tirage faciles à examiner et de tenir votre équipe informée, afin d’améliorer la collaboration et la qualité des révisions.

Faciliter la révision de vos modifications

Un contexte clair dans vos demandes de tirage aide les réviseurs à voir rapidement vos modifications et pourquoi elles sont importantes. Le processus de révision est ainsi plus rapide et plus fluide, avec moins d’allers-retours, ce qui permet à votre équipe de fournir de meilleurs commentaires et de prendre des décisions en toute confiance. Pour plus d'informations sur la création d'une demande d'extraction, voir Création d’une demande de tirage.

Écrire de petites demandes de tirage

Visez à créer de petites demandes de tirage ciblées qui répondent à un seul objectif. Les petites demandes sont plus faciles et plus rapides à examiner et à fusionner, elles laissent moins de place à l'introduction de bogues et fournissent un historique plus clair des modifications.

Révisez votre propre demande de tirage en premier

Révisez, générez et testez votre propre demande de tirage avant de l’envoyer. Cela vous permettra d’intercepter des erreurs ou des fautes de frappe que vous avez peut-être manquées avant que d’autres commencent à réviser.

Fournir un contexte et des conseils

Écrivez des titres et des descriptions clairs pour vos demandes de tirage afin que les réviseurs puissent rapidement comprendre ce que fait la demande de tirage. Dans le corps de la demande, spécifiez :

• l’objectif de la demande de tirage ;
• une vue d’ensemble de ce qui a changé ; et
• des liens vers du contexte supplémentaire, tels que le suivi des problèmes ou des conversations précédentes.

Pour aider les réviseurs, partagez le type de commentaires dont vous avez besoin. Par exemple, avez-vous besoin d’un coup d'œil rapide ou d’une critique plus approfondie ? De plus, vous pouvez utiliser GitHub Copilot pour générer un résumé de votre demande de tirage. Voir Utilisez GitHub Copilot pour générer des résumés de demandes d'extraction, plus loin dans cet article.

Si votre demande de tirage se compose de modifications apportées à plusieurs fichiers, fournissez des conseils aux réviseurs sur l’ordre dans lequel passer en revue les fichiers. Recommandez où commencer et comment procéder à la révision.

Tenir votre équipe informée

Les demandes de tirage ne se limitent pas à documenter les modifications apportées au code : elles constituent également un moyen efficace de tenir votre équipe et votre responsable informés de l’état d’avancement de votre travail. En rendant vos progrès visibles dans vos demandes de tirage, vous pouvez réduire le besoin de mises à jour séparées et vous assurer que tout le monde reste aligné.

Utilisez GitHub Copilot pour générer des résumés de demande de tirage

Vous pouvez utiliser Copilot pour générer un résumé d’une demande de tirage sur GitHub. Vous pouvez utiliser le résumé pour aider les réviseurs à comprendre vos modifications.

1. Dans GitHub, créez une demande de tirage ou accédez à une demande de tirage existante.

   Note

   GitHub Copilot ne tient pas compte du contenu existant dans la description de la demande de tirage. Il est donc préférable de commencer par une description vide.

2. Accédez au champ de texte dans lequel vous souhaitez ajouter le résumé de la demande de tirage.

   • Si vous créez une demande de tirage, utilisez le champ Ajouter une description.
   • Si vous ajoutez une description à une demande de tirage existante, modifiez le commentaire d’ouverture.
   • Si vous ajoutez un résumé en tant que commentaire, accédez à la section Ajouter un commentaire en bas de la page de demande de tirage.

3. Dans l’en-tête du champ de texte, sélectionnez , puis cliquez sur Résumé.

   

4. Attendez que GitHub Copilot produise le résumé, puis vérifiez soigneusement les résultats.

5. Ajoutez tout contexte supplémentaire qui aidera les utilisateurs à consulter votre demande de tirage.

6. Lorsque vous êtes satisfait de la description, cliquez sur Créer une demande de tirage sur une nouvelle demande de tirage ou sur Mettre à jour le commentaire si vous modifiez une description existante.

Lien vers des problèmes ou des projets connexes

Connectez votre demande de tirage aux problèmes pertinents ou aux tableaux de projet pour montrer comment votre travail s’adapte à l’ensemble du projet.

• Ajoutez des mots clés comme Closes ISSUE-LINK dans votre description pour lier et fermer automatiquement le problème lorsque la demande de tirage est fusionnée.
• Utilisez Projects pour suivre votre travail et établir un lien vers le projet à partir de votre demande de tirage, ce qui facilite le suivi de la progression dans un seul endroit. Consultez À propos des Projects.

Mettez en surbrillance l’état avec des étiquettes

Ajoutez une étiquette d’état à votre demande de tirage pour indiquer si elle est prête à être examinée, bloquée ou en cours. Cela permet aux évaluateurs de comprendre l’état de votre travail en un coup d’œil. Pour plus d’informations, consultez « Gestion des étiquettes ».