Utilisation de Copilot pour explorer un codebase

GitHub Copilot Chat peut vous aider à comprendre le contenu, la structure et les fonctionnalités d’un codebase.

Dans cet article

Introduction

Si vous avez été affecté à un projet que vous ne connaissez pas bien, ou si vous avez trouvé un projet open source intéressant auquel vous souhaitez contribuer, vous aurez besoin d’une certaine compréhension du codebase avant de pouvoir commencer à apporter des modifications. Ce guide vous montrera comment utiliser GitHub Copilot Chat pour explorer un codebase et vous familiariser rapidement avec le projet.

Utilisation de Copilot Chat

Tout au long de ce guide, nous travaillerons sur GitHub.com, en utilisant Copilot Chat en mode Assistance, qui affiche un panneau Copilot Chat dans le coin inférieur droit de votre page actuelle sur GitHub.com.

Vous pouvez développer le panneau Copilot Chat pour afficher plus d’espace pour les réponses de Copilot en cliquant et en faisant glisser les bords du panneau.

Utilisation des prompts prédéfinis

Copilot Chat est fourni avec un ensemble de prompts prédéfinis qui peuvent vous aider à commencer à explorer un codebase. Vous pouvez utiliser les prompts en cliquant sur un bouton dans le panneau de conversation. Les boutons s’affichent lorsque vous démarrez une nouvelle conversation avec Copilot Chat. La sélection des prompts varie en fonction de la page actuellement affichée sur GitHub.com.

  1. Ouvrez le référentiel que vous souhaitez explorer sur GitHub.com.

  2. Cliquez sur l’onglet Code pour afficher la page principale du référentiel.

  3. Appuyez sur Maj+C pour ouvrir Copilot Chat en mode Assistance.

  4. Cliquez sur le bouton Recherche sur ce référentiel dans le panneau de conversation.

    Capture d’écran du panneau de conversation avec le bouton « Recherche sur ce référentiel » mis en évidence.

    Conseil

    Si ce bouton n’apparaît pas, assurez-vous que vous êtes bien sur la page principale du référentiel et cliquez sur le signe plus () en haut à droite du panneau Copilot pour démarrer une nouvelle conversation.

    Un prompt prédéfini est soumis à Copilot et la réponse s’affiche dans le panneau de discussion.

  5. Après avoir lu la réponse, vous pouvez également cliquer sur le signe plus () en haut à droite du panneau Copilot pour démarrer une nouvelle conversation, puis cliquer sur Comment démarrer avec ce référentiel.

Exemples d’invites

Les prompts suivants sont des exemples du type de questions que vous pouvez poser à Copilot pour vous aider à en savoir plus sur un codebase.

Questions générales

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

  • 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

Utilisez Copilot pour vous aider à 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. Appuyez sur Maj+C pour ouvrir Copilot Chat en mode Assistance.
  3. 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. Appuyez sur Maj+C pour ouvrir Copilot Chat en mode Assistance.
  3. Pour un petit fichier, demandez à Copilot : Explain this file.
  4. 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.

En savoir plus sur les commits

Pour vous familiariser avec un projet, vous pouvez notamment consulter les travaux récemment réalisés. Pour ce faire, parcourez les commits récents.

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

  2. Dans la page principale du dépôt, au-dessus de la liste des fichiers, cliquez sur commits.

    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 panneau Copilot Chat, 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

En plus d’utiliser Copilot pour vous familiariser avec un projet, vous pouvez également utiliser l’onglet Informations 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 aller plus loin