Accélérer les demandes de tirage dans votre entreprise avec GitHub Copilot

Le guide est inspiré par Playbook pour la réussite des systèmes d'ingénierie (ESSP) de GitHub, qui recommande des stratégies et des indicateurs pour améliorer les systèmes d'ingénierie.

Si vous démarrez un déploiement de Copilot, nous vous recommandons de définir vos objectifs, de planifier votre déploiement en conséquence et de communiquer clairement les objectifs au personnel. Consultez Atteindre les objectifs d’ingénierie de votre entreprise avec GitHub Copilot.

1. Identifier les obstacles au succès

Les équipes rencontrent souvent des retards dans la fusion des demandes de tirage en raison de cycles de révision longs. Ces retards découlent souvent des éléments suivants :

• Modifications de code complexes, difficiles à comprendre
• Mise en forme incohérente du code qui rend les révisions difficiles
• Modifications généralement fournies sans le contexte nécessaire
• Facteurs sociaux qui contribuent à des révisions lentes ou difficiles

De plus, il n'est pas rare que les réviseurs passent à côté de petites erreurs susceptibles d’entraîner des problèmes de production.

Cela entraîne des goulots d’étranglement dans le processus de développement qui ralentissent la livraison globale et détériorent la qualité des fonctionnalités.

2. Évaluez vos options

L’étape suivante consiste à évaluer et à accepter des solutions pour résoudre les obstacles que vous avez identifiés à l’étape 1. Dans ce guide, nous allons nous concentrer sur l’impact que GitHub Copilot peut avoir sur l’objectif que vous avez identifié. Les déploiements réussis d’un nouvel outil nécessitent également des modifications apportées à la culture et aux processus.

Exécuter des essais de nouveaux outils et processus avec des groupes pilotes pour recueillir des commentaires et mesurer la réussite. Pour connaître les ressources et les métriques d’apprentissage à utiliser pendant les essais, consultez 3. Implémentez les modifications et les métriques pour surveiller les sections.

          <a href="https://github.com/github-copilot/purchase?ref_product=copilot&ref_type=trial&ref_style=button&ref_plan=enterprise" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline">              <span>Inscrivez-vous à Copilot</span> <svg version="1.1" width="16" height="16" viewBox="0 0 16 16" class="octicon octicon-link-external" aria-label="link external icon" role="img"><path d="M3.75 2h3.5a.75.75 0 0 1 0 1.5h-3.5a.25.25 0 0 0-.25.25v8.5c0 .138.112.25.25.25h8.5a.25.25 0 0 0 .25-.25v-3.5a.75.75 0 0 1 1.5 0v3.5A1.75 1.75 0 0 1 12.25 14h-8.5A1.75 1.75 0 0 1 2 12.25v-8.5C2 2.784 2.784 2 3.75 2Zm6.854-1h4.146a.25.25 0 0 1 .25.25v4.146a.25.25 0 0 1-.427.177L13.03 4.03 9.28 7.78a.751.751 0 0 1-1.042-.018.751.751 0 0 1-.018-1.042l3.75-3.75-1.543-1.543A.25.25 0 0 1 10.604 1Z"></path></svg></a>

Comment Copilot peut vous aider

GitHub Copilot offre une suite de fonctionnalités conçues pour accélérer le processus d'examen des demandes d'extraction, améliorer la qualité du code et renforcer la collaboration, ce qui raccourcit au final les délais de fusion.

En tirant parti des capacités de Copilot, les équipes peuvent rationaliser leurs flux de travail, réduire les frictions et garantir un code cohérent et de haute qualité.

Génère des résumés complets et utiles sur les demandes de tirage

Copilot peut générer automatiquement des résumés clairs et concis des demandes de tirage, ce qui permet aux développeurs de gagner du temps et garantit que l'objectif et les modifications apportées aux demandes de tirage sont facilement compréhensibles par les réviseurs. Cela réduit la probabilité de malentendus et accélère le processus d’examen.

Aide les réviseurs pendant leur processus de révision

GitHub Copilot peut être utilisé comme un puissant outil d'aide à la révision des demandes de tirage.

• Copilot peut aider à expliquer les modifications complexes apportées au code afin que les réviseurs comprennent plus rapidement ce que la demande de tirage apporte.
• Copilot peut fournir des suggestions contextuelles à l'échelle du dépôt et des améliorations potentielles du code directement dans l'interface de révision des demandes de tirages sur GitHub, aidant ainsi les réviseurs à détecter les problèmes potentiels et à fournir des commentaires constructifs plus efficacement.
• Copilot peut aider les réviseurs à rédiger et à écrire des commentaires clairs, cohérents et efficaces.

Révisions basées sur les instructions de l’organisation

• Copilot peut examiner les modifications apportées au code dans votre IDE avant d'ouvrir une demande de tirage ou être désigné comme réviseur d'une demande de tirage.
• Avec les ensembles de règles, vous pouvez configurer Copilot afin d'examiner systématiquement les demandes de tirages en fonction de critères personnalisés.
• Grâce à des instructions personnalisées pour les révisions, Copilot peut appliquer les normes de codage et les meilleures pratiques de l’organisation en signalant automatiquement les violations potentielles et en suggérant des correctifs.

Ces fonctionnalités garantissent la cohérence dans le codebase et vous aident à détecter les erreurs au début du processus de développement, ce qui réduit la nécessité de révisions manuelles du code, d'où un gain de temps pour les développeurs et les réviseurs.

Suggère des correctifs de code

À partir d'un commentaire sur une demande de tirage, Copilot peut aider les auteurs de demandes de tirage à mettre rapidement en œuvre les modifications de code nécessaires pour résoudre le problème.

Considérations culturelles

En plus de votre déploiement de GitHub Copilot, résolvez tous les facteurs sociaux ou culturels qui pourraient vous empêcher d’atteindre vos objectifs.

Les exemples suivants sont tirés de la section « Anti-modèles » de l’ESSP.

• Parfois, les équipes attendent trop longtemps avant la mise en production et doivent alors déployer des lots volumineux de code en une seule fois. Cela peut être motivé par la crainte que des mises en production fréquentes génèrent une déstabilisation, par un manque de maturité du pipeline CI/CD ou par des exigences strictes en matière de conformité.
• Les développeurs peuvent passer trop de temps à perfectionner le code ou à ajouter des fonctionnalités inutiles. Une culture perfectionniste ou des difficultés à établir des priorités peuvent en être la cause.
• Les développeurs ont parfois tendance à créer des solutions trop complexes à des problèmes simples. Cela peut être dû à un désir excessif de prévention ou à une pression les incitant à ajouter de la valeur par le biais de la complexité.

3. Mettre en œuvre des changements

Lorsque vous avez identifié la bonne approche pour surmonter vos obstacles, mettez à l’échelle les solutions que vous avez identifiées. Pour un déploiement réussi d’un nouvel outil ou d’un processus, attribuez la propriété à chaque partie du déploiement, communiquez de manière transparente sur vos objectifs, fournissez une formation efficace et mesurez vos résultats.

Cette section fournit des exemples de scénarios, des bonnes pratiques et des ressources pour les développeurs. Utilisez cette section pour planifier des sessions de communication et de formation pour aider les employés à utiliser Copilot d’une manière qui s’aligne sur votre objectif.

•           [Créer des résumés de demandes de tirage utiles](#create-helpful-pull-request-summaries)
  

•           [Utiliser Copilot comme assistant de révision](#use-copilot-as-a-review-assistant)
  

•           [Ajouter Copilot en tant que réviseur](#add-copilot-as-a-reviewer)
  

•           [Obtenir de l’aide pour implémenter des commentaires de révision](#get-help-implementing-review-comments)
  

•           [Bonnes pratiques pour les développeurs](#best-practices-for-developers)
  

•           [Ressources](#resources)
  

Créer des résumés de demandes de tirage utiles

1. Lorsque vous créez une demande de tirage, cliquez sur l'icône Copilot dans le champ « Ajouter une description », puis cliquez sur Résumé.
2. Copilot analysera la demande de tirage et fournira un aperçu des modifications apportées sous forme de texte, ainsi qu'une liste à puces des modifications avec les fichiers concernés.
3. Vérifiez que vous êtes satisfait de la description de Copilot.
4. Lorsque les réviseurs arriveront à votre demande de tirage, ils auront tout le contexte dont ils ont besoin pour quitter une révision.

Utiliser Copilot comme assistant de révision

Lorsque vous participez à une demande de tirage en tant que réviseur, vous pouvez utiliser Copilot pour accélérer votre révision.

1. Utilisez Copilot pour comprendre les modifications apportées dans la demande de tirage.

   • Demandez à Copilot de résumer les modifications apportées à un fichier. Cela s'avère particulièrement utile lorsque la liste des différences est longue. Vous pouvez sélectionner un fichier spécifique dans la vue Diff en cliquant sur dans le coin supérieur droit du fichier.

     

   • Pour les modifications apportées à des lignes spécifiques, mettez en surbrillance les lignes que vous souhaitez mieux comprendre et demandez à Copilot de vous expliquer les modifications. Pour sélectionner un ensemble de lignes, cliquez d'abord sur la ligne la plus haute du diff puis, en maintenant la touche MAJ enfoncée, cliquez sur la ligne la plus basse.

     

2.           **Collaborez sur votre révision de demande de tirage** avec Copilot. N'oubliez pas de joindre les différences de fichiers spécifiques à la conversation avant de solliciter Copilot.
   

   • Vous pouvez demander à Copilot son avis sur les modifications apportées à la demande de requête en lui posant la question suivante : Provide your judgement as a PR Reviewer, both for functional and non-functional aspects that these changes bring. Remarquez comment ce prompt demande à Copilot de prendre en compte à la fois les aspects fonctionnels et non fonctionnels du code.

   • Pour vos propres commentaires de révision d'une demande de tirage, demandez à Copilot un deuxième avis : As my peer reviewer on this pull request, give me your feedback on my own review: YOUR-REVIEW-COMMENT. Do you think it's pertinent? Am I missing something?

3. Collaborez avec Copilot pour rédiger et peaufiner vos commentaires de révision.

   • Après avoir planifié la révision avec Copilot, vous pouvez demander la liste des commentaires que vous devez fournir : Make a list of review comments to add to the PR and tell me exactly in which file diff and lines each comment should be added.
   • Vous pouvez également demander à Copilot de créer une première ébauche du commentaire de révision que vous avez en tête ou d'affiner un commentaire avant de le publier : Help me draft review comments as discussed ou Refine this review comment to make it clear, concise, and actionable.

Ajouter Copilot en tant que réviseur

Pour réduire les délais de révision et fusionner plus rapidement les demandes de tirage, utilisez systématiquement les révisions de code Copilot : d'abord dans l'IDE avant d'ouvrir la demande de tirage, puis sur la demande de tirage dans GitHub.

L'utilisation de Copilot pour réviser le code ne remplace pas la nécessité d'une révision humaine. Toutefois, en suivant les étapes ci-dessus, les humains peuvent effectuer leurs révisions plus rapidement.

•           Les **développeurs** doivent demander une révision de toutes leurs modifications du code à l’aide de Copilot avant d’ouvrir une requête de tirage.
  

•           Les **administrateurs** doivent configurer des ensembles de règles de dépôt ou d'organisation afin d'ajouter automatiquement Copilot en tant que réviseur sur toute demande de tirage ciblant des branches protégées.
  

•           Les **responsables d’équipe** doivent capturer le style et les règles standard de leur équipe et les définir comme des instructions personnalisées pour l’organisation afin que Copilot puisse les exploiter dans les révisions.
  

  • Assurez-vous que vos instructions personnalisées capturent un ensemble minimal de recommandations de style qui améliorent la lisibilité du code. Cela vous aidera pendant le processus de révision des demandes de tirage.
  • Pour réduire le nombre de commentaires de révision de demandes de tirage liés à des problèmes de style, définissez les mêmes recommandations dans les instructions Copilot au niveau du dépôt et de l'organisation. De cette manière, le code généré par Copilot sera conforme à ces directives.

Obtenir de l’aide pour implémenter des commentaires de révision

Les auteurs de demandes de tirage peuvent accélérer la résolution des commentaires sur ces demandes de tirage en implémentant rapidement des corrections à l'aide de Copilot.

• Pour tout commentaire de révision laissé par Copilot, validez directement la correction proposée ou modifiez-la dans Copilot Workspace avant de la valider.
• Pour tout commentaire de révision d'une demande de tirage laissé par vos pairs, accédez au fichier diff associé à ce commentaire et joignez le diff à une conversation Tchat Copilot. Ensuite, copiez le commentaire de révision avec un prompt comme suit : Suggest a fix for this review comment:
• Si vous utilisez VS Code, demandez à GitHub Copilot en mode assistant d'implémenter les modifications requises à partir du commentaire de révision.

Bonnes pratiques pour les développeurs

Les développeurs doivent :

• Demander la révision de Copilot dans leur IDE avant de l'envoi afin de détecter et de résoudre les problèmes dès le début.
• Utiliser Copilot pour planifier et affiner leurs propres commentaires de révision des demandes de tirage afin d'aider les auteurs de ces demandes à comprendre et à résoudre les problèmes.
• Joindre le contexte diff pertinent, y compris les lignes de code spécifiques, à leurs conversations avec Copilot.

Les développeurs ne doivent pas :

• Appliquer les suggestions de Copilot sans les tester.
• Se fier uniquement à Copilot pour les révisions.
• Négliger la lisibilité du code.

Ressources

•           [AUTOTITLE](/copilot/using-github-copilot/using-github-copilot-for-pull-requests/creating-a-pull-request-summary-with-github-copilot)
  

•           [AUTOTITLE](/copilot/using-github-copilot/code-review/using-copilot-code-review?tool=vscode#reviewing-changes)
  

•           [AUTOTITLE](/copilot/how-tos/configure-custom-instructions/add-repository-instructions)
  

•           [AUTOTITLE](/copilot/how-tos/agents/copilot-code-review/automatic-code-review)
  

•           [AUTOTITLE](/copilot/customizing-copilot/adding-organization-custom-instructions-for-github-copilot)
  

Mesures à surveiller

Pour évaluer les essais de nouveaux outils et vous assurer que vos déploiements complets offrent des améliorations cohérentes, surveillez les résultats et apportez des ajustements si nécessaire. Nous vous recommandons de prendre en compte les zones clés de la qualité, de la vélocité et du bonheur des développeurs, et la façon dont ces zones se réunissent pour contribuer aux résultats métier.

Voici quelques métriques permettant d’évaluer l'impact de Copilot sur cet objectif spécifique.

•           **Satisfaction des développeurs** : utilisez des enquêtes auprès des développeurs pour mesurer leur satisfaction vis-à-vis des outils d’ingénierie.
  

•           **Demandes de tirage fusionnées par développeur** : vous pouvez utiliser le webhook `pull request`, en vous assurant que `action` est `closed` et que la propriété `merged` dans l’objet `pull request` est `true`.
  

•           **Délai d’exécution des demandes de tirage** : mesurez la durée moyenne entre la création et la fusion des demandes de tirage.
  

•           **Taux d’échappement des défauts des demandes de tirage** : mesurez le taux de problèmes de déploiement causés par des demandes de tirage mal révisées.
  

•           **Type de commentaire de révision des demandes de tirage** : téléchargez les commentaires de révision des demandes de tirage, catégorisez-les à l’aide d’une classification de sujets basée sur l’IA et suivez les commentaires formulés par les réviseurs humains sur la conception, la scalabilité et la stratégie.