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 montrera comment utiliser GitHub Copilot Chat pour explorer une base de code et découvrir rapidement les projets.
Travailler avec Copilot Chat
Tout au long de ce guide, nous allons utiliser Copilot Chat sur GitHub.com, que vous trouverez à github.com/copilote.
Attachement d’une base de code
Avant que Copilot Chat puisse vous aider, vous devez joindre le codebase que vous souhaitez explorer.
- Sur GitHub, accédez à github.com/copilot.
- Dans la zone de texte, cliquez sur Ajouter des référentiels, des fichiers et des espaces, puis cliquez sur Référentiels.
- Recherchez et sélectionnez le référentiel que vous souhaitez explorer.
Copilot Chat a maintenant accès au code du référentiel, et vous pouvez commencer à poser des questions à ce sujet.
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 :
-
Accédez au répertoire sur GitHub.com.
-
Dans le coin supérieur droit de la page, cliquez sur l’icône Copilot () pour ouvrir Copilot Chat.
Copilot utilise le contenu du répertoire comme contexte pour votre question.
-
Demandez à Copilot :
Explain the files in this directory.
Pour en savoir plus sur un fichier spécifique :
-
Ouvrez le fichier sur GitHub.com.
-
Dans le coin supérieur droit de la page, cliquez sur l’icône Copilot () pour ouvrir Copilot Chat.
Copilot utilise le contenu du fichier comme contexte pour votre question.
-
Pour un petit fichier, demandez à Copilot :
Explain this file. -
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
Utilisez Copilot pour vous aider à comprendre des lignes de code spécifiques dans un fichier.
Pour en savoir plus sur une ligne de code spécifique :
-
Sur GitHub, accédez à un référentiel et ouvrez un fichier.
-
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.
-
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 panneau GitHub Copilot Chat avec les lignes sélectionnées indiquées comme contexte de votre question.
-
Pour poser une question prédéfinie, cliquez sur le bouton pointant vers le bas à côté de l’icône de Copilot, puis choisissez l’une des options.
-
Si vous avez cliqué sur l’icône Copilot, tapez une question dans la zone de prompt en bas du panneau de conversation et appuyez sur Entrée.
Compréhension d’un fichier ou d’un symbole spécifique
Utilisez Copilot pour vous aider à 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.
-
Sur GitHub, accédez à un référentiel et ouvrez un fichier.
-
Dans le coin supérieur du fichier, cliquez sur l’icône Copilot () pour ouvrir Copilot Chat.
Copilot affichera le contenu du fichier dans un écran partagé comme contexte pour votre question.
-
Si vous voulez poser des questions sur un symbole spécifique, surlignez le symbole dans le fichier.
-
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 la fenêtre de chat.
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.
-
Sur GitHub, accédez à la page principale du référentiel.
-
Sur la page principale du référentiel, au-dessus de la liste des fichiers, cliquez sur engagements.
-
Cliquez sur un message de commit pour afficher une vue diff pour ce commit.
-
Dans le panneau Copilot Chat, entrez :
What does this commit do?. -
Si nécessaire, vous pouvez assurer un suivi en entrant :
Explain in more detail.
Utilisation de l’onglet Informations
Outre l’utilisation de 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 ».