Utilisation de GitHub Copilot pour explorer une base de code

GitHub Copilot Chat peut vous aider à comprendre le contenu, la structure et les fonctionnalités d’une base de code.

Dans cet article

Introduction

Si vous avez été affecté pour travailler sur un project que vous n'êtes pas familiarisé avec ( ou si vous avez trouvé un open source project intéressant auquel vous souhaitez contribuer), vous aurez besoin d'une certaine compréhension de la base de code avant de commencer à apporter des modifications. Ce guide vous montre comment utiliser GitHub Copilot Chat pour explorer une base de code et découvrir rapidement le projet.

Utilisation de Discussion avec Copilot

Tout au long de ce guide, nous allons travailler avec Discussion avec Copilot sur GitHub.com, que vous trouverez à github.com/copilot.

Fourniture d’un contexte de référentiel

Vous pouvez demander à Discussion avec Copilot des informations sur une base de code de l’une des façons suivantes.

Attachement d’un référentiel dans la conversation

L’attachement d’un référentiel donne Discussion avec Copilot accès au code dans le référentiel et est préférable lorsque vous souhaitez comparer ou basculer entre les référentiels pendant une conversation.

  1. Sur GitHub, accédez à github.com/copilot.
  2. Dans la zone de texte, cliquez sur Ajouter des référentiels, des fichiers et des espaces, puis cliquez sur Référentiels.
  3. Recherchez et sélectionnez le référentiel que vous souhaitez explorer.

Poser une question depuis la page du dépôt

Remarque

Cette fonctionnalité est actuellement en cours préversion publique et susceptible de changer.

Vous pouvez interroger Discussion avec Copilot au sujet d’un dépôt directement depuis sa page sur GitHub, sans d’abord l’attacher. Il s’agit d’un moyen rapide de vous orienter dans un projet sur lequel vous n’avez pas travaillé avant.

  1. Sur GitHub, accédez au référentiel que vous souhaitez explorer.
  2. Ouvrez Discussion avec Copilot à partir de la page du référentiel et posez une question. Copilot utilise le référentiel comme contexte et a pour motif ses réponses dans les fichiers et symboles réels du référentiel.
  3. Posez une question de suivi pour aller plus loin, en utilisant le même contexte partagé.

Exemples d’invites

Les requêtes suivantes sont des exemples du type de questions que vous pouvez poser à Copilot pour vous aider à en savoir plus sur une base de code.

Questions générales

  • Based on the code in this repository, give me an overview of the architecture of the codebase. Provide evidence.

  • Give me an overview of this repository: its purpose, structure, key components, and how to run it.

  • What are the main entry points and how do the key components fit together?

  • Which languages are used in this repo? Show the percentages for each language.

  • What are the core algorithms implemented in this repo?

  • What design patterns are used in this repository? Give a brief explanation of each pattern that you find, and an example of code from this repository that uses the pattern, with a link to the file.

Questions spécifiques

L’utilité de ces questions dépendra du codebase que vous explorez.

  • How do I build this project?

  • Where is authentication handled in this codebase?

  • Analyze the code in this repository and tell me about the entry points for this application.

  • Describe the data flow in this application.

  • Analyze the code in this repository and tell me what application-level security mechanisms are employed. Provide references.

Comprendre les fichiers dans un répertoire

Permet Copilot de comprendre l’objectif des fichiers dans un répertoire ou des fichiers individuels.

Pour en savoir plus sur les fichiers d’un répertoire :

  1. Accédez au répertoire sur GitHub.com.

  2. Dans le coin supérieur droit de la page, cliquez sur l’icône Copilot () pour ouvrir Discussion avec Copilot.

Copilot utilisera le contenu du répertoire comme contexte pour votre question.

  1. Demandez Copilot: Explain the files in this directory.

Pour en savoir plus sur un fichier spécifique :

  1. Ouvrez le fichier sur GitHub.com.

  2. Dans le coin supérieur droit de la page, cliquez sur l’icône Copilot () pour ouvrir Discussion avec Copilot.

Copilot utilisera le contenu du fichier comme contexte pour votre question.

  1. Pour un petit fichier, demandez Copilot: Explain this file.
  2. Pour un fichier volumineux, demandez : Explain what this file does. Start with an overview of the purpose of the file. Then, in appropriately headed sections, go through each part of the file and explain what it does in detail.

Présentation des lignes de code spécifiques

Permet Copilot de comprendre des lignes de code spécifiques dans un fichier.

Pour en savoir plus sur une ligne de code spécifique :

  1. Sur GitHub, accédez à un référentiel et ouvrez un fichier.

  2. Sélectionnez les lignes en cliquant sur le numéro de ligne de la première ligne que vous souhaitez sélectionner, maintenez la touche Maj enfoncée et cliquez sur le numéro de ligne de la dernière ligne que vous souhaitez sélectionner.

  3. Pour poser votre propre question sur les lignes sélectionnées, cliquez sur l’icône Copilot () à droite de votre sélection. Cela affiche le GitHub Copilot Chat panneau avec les lignes sélectionnées indiquées comme contexte de votre question.

  4. Pour poser une question prédéfinie, cliquez sur le bouton pointant vers le bas à côté de l’icône Copilot , puis choisissez l’une des options.

    Capture d’écran des boutons Copilot mis en surbrillance avec un encadré orange foncé, à droite de certains codes sélectionnés.

  5. Si vous avez cliqué sur l’icône Copilot , tapez une question dans la zone d’invite en bas du panneau de conversation, puis appuyez sur Entrée.

Compréhension d’un fichier ou d’un symbole spécifique

Permet Copilot de comprendre l’objectif d’un fichier ou d’un symbole spécifique dans la base de code. Un symbole est une entité nommée dans le code, telle qu’une fonction, une classe ou une variable.

  1. Sur GitHub, accédez à un référentiel et ouvrez un fichier.

  2. En haut du fichier, cliquez sur l’icône Copilot () pour ouvrir Discussion avec Copilot.

Copilot affiche le contenu du fichier dans un écran fractionné en tant que contexte pour votre question.

  1. Si vous voulez poser des questions sur un symbole spécifique, surlignez le symbole dans le fichier.

  2. Dans la zone d’invite, tapez une question sur le fichier ou le symbole mis en surbrillance, puis appuyez sur Entrée.

Copilot répond dans le panneau de conversation.

Conseil

La capacité de Copilot à répondre à des questions en langage naturel comme celles-ci dans le contexte d'un référentiel est optimisée lorsque l'index de recherche de code sémantique pour le référentiel est à jour. Pour plus d’informations, consultez « Indexation de référentiels pour GitHub Copilot ».

En savoir plus sur les commits

Une bonne façon de vous familiariser avec un project est de regarder le travail récent qui se passe. Pour ce faire, parcourez les commits récents.

  1. Sur GitHub, accédez à la page principale du référentiel.

  2. Sur la page principale du référentiel, au-dessus de la liste des fichiers, cliquez sur engagements.

    Capture d’écran de la page principale d’un dépôt. Une icône d’horloge et le texte « 178 commits » sont mis en évidence avec un encadré orange.

  3. Cliquez sur un message de commit pour afficher une vue diff pour ce commit.

  4. Dans le Discussion avec Copilot panneau, entrez : What does this commit do?.

  5. Si nécessaire, vous pouvez assurer un suivi en entrant : Explain in more detail.

Utilisation de l’onglet Informations

Outre l’utilisation Copilot pour vous aider à vous familiariser avec un projet, vous pouvez également utiliser l’onglet Insights sur GitHub.com. Cela vous donne une vue d’ensemble très détaillée du référentiel.

Pour plus d’informations, consultez « Utilisation de Pulsation pour afficher un résumé de l’activité du référentiel » et « Affichage des contributeurs d’un projet ».

Pour approfondir