Utilisation de l’agent cloud GitHub Copilot pour améliorer un projet

Présentation

Le développement moderne commence souvent par de bonnes intentions : un script rapide, un prototype, peut-être une action pour automatiser une petite chose. Mais à mesure que les projets évoluent, ces premiers efforts peuvent devenir fragiles.

Ce tutoriel montre comment vous pouvez utiliser Agent Copilot cloud pour améliorer un projet mature, sans ralentir votre élan.

Dans les sections suivantes, nous allons :

• Assurez-vous que le projet contient des instructions personnalisées qui Copilot peuvent être utilisées pour adapter ses réponses à votre projet.
• Assurez-vous qu’il existe un fichier de configuration d’environnement pour Agent Copilot cloud, afin qu'il puisse commencer plus rapidement les tâches en préinstallant les dépendances de votre projet.
• Recherchez les améliorations qui peuvent être apportées au code, puis créez Copilot des problèmes pour ce travail.
• Déléguer le travail de codage à Copilot en l’affectant à un problème.

1. Rechercher des instructions personnalisées

1. Accédez à votre dépôt sur GitHub.

2. Vérifiez qu’au moins l’un des fichiers d’instructions personnalisées suivants existe :

   • .github/copilot-instructions.md
   • .github/instructions/**/*-instructions.md
   • AGENTS.md

3. Si l’un de ces fichiers existe, affichez le fichier et vérifiez que les instructions sont adéquates et à jour.

   Pour plus d’informations, consultez la section « Écriture d’instructions personnalisées efficaces » dans À propos de la personnalisation des réponses GitHub Copilot et la bibliothèque d’exemples dans Instructions personnalisées.

4. S’il n’existe aucun fichier d’instructions personnalisé dans le référentiel, utilisez-le Agent Copilot cloud pour créer un .github/copilot-instructions.md fichier en suivant les instructions de Ajout d’instructions personnalisées de référentiel pour GitHub Copilot.

5. Passez en revue la pull request que Agent Copilot cloud crée. Vérifiez que le .github/copilot-instructions.md fichier fournit Copilot toutes les informations dont il a besoin pour travailler sur ce projet.

   Le fichier doit inclure :

   • Résumé clair de la base de code et de ce que fait le logiciel.
   • Vue d'ensemble de la structure du projet.
   • Recommandations en matière de contribution. Par exemple, comment générer, mettre en forme, vérifier et tester la base de code, ainsi que les exigences qui doivent être remplies avant que les pull requests puissent être fusionnées.
   • Principes techniques clés.

6. Modifiez le fichier en fonction des besoins.

7. Cliquez sur Prêt pour la révision en bas de l’onglet « Conversation » de la demande de tirage, puis effectuez votre processus habituel de fusion d’une demande de tirage.

2. Rechercher un fichier de configuration d'environnement

Un copilot-setup-steps.ymlGitHub Actions fichier de flux de travail peut aider Agent Copilot cloud à démarrer plus rapidement sur les tâches en préinstallant les dépendances utilisées par le projet.

La création de ce fichier est facultative, mais c’est une bonne idée si vous utilisez Agent Copilot cloud régulièrement dans le référentiel.

1. Dans votre référentiel sur GitHub, vérifiez que le fichier suivant existe :

   Text

   .github/workflows/copilot-setup-steps.yml
   

   Conseil

   Un moyen rapide pour ce faire est de copier le chemin ci-dessus, d’accéder à la page principale de votre référentiel et de coller le chemin dans le champ « Aller au fichier ».

2. Si le fichier existe, ouvrez-le et vérifiez que les étapes du flux de travail installent les dépendances appropriées pour votre project. Après avoir vérifié cela, vous pouvez ignorer les étapes restantes de cette section.

3. Si vous n’avez pas encore de fichier copilot-setup-steps.yml, utilisez les étapes suivantes pour que Agent Copilot cloud le crée pour vous.

4. En haut de n’importe quelle page de votre dépôt sur le site web GitHub, cliquez sur .

5. Copiez et collez l’invite suivante dans la boîte de dialogue Agents :

   Text

   Analyze this repository to understand the dependencies that need to be installed on the development environment to work on the code in this repository. Using this information, and the details about the `copilot-setup-steps.yml` file that are given in https://docs.github.com/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment, add a `.github/workflows/copilot-setup-steps.yml` to this repository. This Actions workflow file should install, in the development environment for Agent Copilot cloud, all of the dependencies necessary to work on the code in this repository. Make sure that the workflow job is named `copilot-setup-steps`.
   

6. Cliquez ou appuyez sur Entrée.

7. Dans la liste « Sessions d’agent récentes », cliquez sur la nouvelle session d’agent qui a démarré.

   Cela affiche un journal d’activité, à mesure que Copilot travaille sur la tâche. Une fois Copilot terminé, il génère un résumé de ce qu’il a fait.

8. Lisez le résumé, puis cliquez sur Afficher la pull request.

9. Si vous le souhaitez, ajoutez Copilot en tant que réviseur. Pour plus d’informations, consultez « Utilisation de la révision de code GitHub Copilot ». Attendez que Copilot ajoute des commentaires de révision, puis apportez les modifications que vous jugez nécessaires en réponse aux commentaires.

10. Passez en revue le pull request vous-même, en vérifiant que les étapes d’installation dans le nouveau fichier copilot-setup-steps.yml sont correctes.

    Le fichier de flux de travail créé Copilot doit inclure un déclencheur, pour vous permettre d’exécuter on: workflow_dispatch le flux de travail manuellement, et le travail doit être nommé copilot-setup-steps comme indiqué dans cet extrait :

    on:
      workflow_dispatch:
      push:
        paths:
          - .github/workflows/copilot-setup-steps.yml
      pull_request:
        paths:
          - .github/workflows/copilot-setup-steps.yml
    
    jobs:
      copilot-setup-steps:
        runs-on: ubuntu-latest
    

11. Apportez les modifications requises au fichier copilot-setup-steps.yml dans la demande de tirage (pull request).

    Vous pouvez demander à Copilot d’apporter des modifications pour vous en utilisant @copilot dans un commentaire de revue. Par exemple:

    @copilot - comment the file more thoroughly

12. Cliquez sur Prêt pour la révision en bas de l’onglet « Conversation » de la demande de tirage, puis effectuez votre processus habituel de fusion d’une demande de tirage.

13. Ouvrez le fichier nouvellement ajouté .github/workflows/copilot-setup-steps.yml dans votre référentiel sur GitHub.

14. Cliquez sur Afficher les exécutions en haut à droite de la page.

15. Cliquez sur Exécuter le flux de travail , puis exécutez le flux de travail dans la boîte de dialogue pour tester le nouveau flux de travail.

16. Vérifiez que le flux de travail s’exécute correctement et installe les dépendances. Corrigez les échecs en modifiant le fichier .github/workflows/copilot-setup-steps.yml.

3. Permettre à Copilot de trouver une dette technique

Maintenant que Copilot dispose du bon contexte et d’un environnement prêt à l’emploi (éventuellement), vous pouvez l’utiliser pour révéler et hiérarchiser la dette technique dans votre dépôt.

1. Cliquez sur le bouton dans la zone d’invite suivante pour envoyer cette invite à Tchat Copilot sur GitHub.com.

   Copilot prompt

   What technical debt exists in this project? Give me a prioritized list of up to 5 areas we need to focus on. For each, describe the problem and its consequences.
   

2. Assurez-vous que le mode Demander est sélectionné.

3. Utilisez la liste déroulante Tous les référentiels pour sélectionner votre référentiel.

4. Cliquez sur ou appuyez sur Entrée.

5. Passez en revue les détails de la réponse de Copilot.

6. En supposant qu’au moins une Copilot zone d’amélioration ait été identifiée, copiez le message suivant dans la même conversation :

   Copilot prompt

   /create-issue
   
   Create a GitHub issue to address the first of the problem areas that you identified.
   
   If the problem area requires substantial work, create one main issue for the entire problem area and then sub-issues that allow the work to be split up into manageable chunks, which will be tackled in separate pull requests that can be easily reviewed. For a large body of work, do not create a single issue that attempts to address the entire problem.
   
   The issue, or each sub-issue if these are created, must include a description of the problem, a set of acceptance criteria, and pointers on what files need to be added/updated.
   

7. Modifiez cette invite en fonction des besoins. Par exemple, en fonction de la réponse produite Copilot , vous pouvez travailler sur une autre zone de problème identifiée Copilot , plutôt que sur la première.

8. Assurez-vous que le mode Demander est toujours sélectionné ().

9. Cliquez sur ou appuyez sur Entrée.

10. Passez en revue le brouillon qui Copilot génère, en le modifiant selon les besoins.

11. Si Copilot crée une ébauche unique qui indique que des sous-problèmes doivent être créés, demandez à Copilot de le faire pour vous :

    Copilot prompt

    Go ahead and create sub-issues that chunk this work into manageable pieces.
    

12. Cliquez sur Créer ou Vérifier et créer, en fonction du nombre de problèmes qui ont été rédigés.

           Copilot crée un ou plusieurs nouveaux problèmes en votre nom. Vous apparaîtrez comme l’auteur du problème.
    

4. Obtenir Copilot pour résoudre un problème

Maintenant que vous avez créé des problèmes, l’étape suivante consiste à déléguer un problème à Copilot et à passer en revue la pull request résultante.

1. Ouvrez l’un des problèmes créés Copilot pour vous dans la section précédente.

2. Vérifiez que le problème contient des critères d’acceptation que Copilot peut utiliser pour vérifier qu’il a terminé la tâche.

3. Apportez les modifications que vous pensez nécessaires pour décrire avec précision le problème qui doit être résolu et le résultat attendu du travail sur ce problème.

4. Cliquez sur Affecter à Copilot.

5. Dans « Affecter Copilot au problème », cliquez sur Affecter.

          Copilot va commencer à travailler sur le problème. Après quelques instants, un lien vers une demande de tirage (pull request) brouillon sera ajouté au problème.
   

6. Cliquez sur le lien vers la demande de tirage brouillon.

   Une fois Copilot avoir terminé de travailler sur la pull request, il supprime « [WIP] » du titre de la pull request et vous ajoute en tant que relecteur.

   Vous pouvez laisser Copilot travailler sur la pull request de manière asynchrone, et revenir pour l'examiner une fois que vous êtes ajouté en tant qu'examinateur.

7. Si vous le souhaitez, après que Copilot a fonctionné pendant quelques minutes, vous pouvez cliquer sur Afficher la session sur la pull request pour voir un journal de ce que Copilot fait.

8. Si vous le souhaitez, sous l’onglet « Conversation » de la pull request, ajoutez Copilot en tant que réviseur.

9. Une fois que vous avez été ajouté en tant que réviseur, passez en revue les modifications vous-même et apportez les modifications requises.

   Vous pouvez demander à Copilot d’apporter des modifications pour vous en utilisant @copilot dans un commentaire de révision.

10. Cliquez sur Prêt pour la révision en bas de l’onglet « Conversation » de la demande de tirage, puis effectuez votre processus habituel de fusion d’une demande de tirage.

5. Itérer sur ce processus

1. Si Copilot a créé plusieurs problèmes, répétez la section 4 en affectant Copilot à l’un des autres problèmes.
2. Après avoir fermé tous les problèmes créés Copilot , répétez la section 3, en choisissant une autre zone de problème et en itérant sur la section 4 pour affecter des problèmes à Copilot et examiner et fusionner ses modifications.

Conclusion

          Agent Copilot cloud peut vous aider à améliorer la qualité du code dans n’importe quel projet, mais il est particulièrement utile de réduire la dette technique dans un projet qui a augmenté de manière organique au cours de plusieurs mois ou années. En utilisant Agent Copilot cloud, vous pouvez apporter des améliorations que vous avez peut-être eu du mal à trouver du temps sans un assistant IA travaillant en votre nom.

          Copilot ne vous remplace pas en tant que développeur , vous devez toujours être impliqué à chaque étape de ce processus, en spécifiant ce que vous souhaitez Copilot faire et en examinant soigneusement le code qu’il modifie ou ajoute, mais il vous permet d’implémenter des améliorations en même temps que vous travaillez sur d’autres tâches importantes.

Étapes suivantes

Lisez cette étude de cas sur le GitHub blog : Comment l’équipe de facturation GitHub utilise agent de cloud dans GitHub Copilot pour réduire continuellement la dette technique.