Ingénierie rapide pour GitHub Copilot Chat

Suivez ces stratégies pour améliorer vos Copilot résultats.

Dans cet article

Une invite est une demande à laquelle vous effectuez GitHub Copilot. Par exemple, une question que vous posez Discussion avec Copilotou un extrait de code que vous demandez Copilot à terminer. En plus de votre invite, Copilot utilise un contexte supplémentaire, comme le code dans votre fichier actuel et l’historique des conversations, pour générer une réponse.

Suivez les conseils de cet article pour écrire des invites qui génèrent de meilleures réponses à partir de Copilot.

Commencer de manière générale, puis préciser

Lors de l’écriture d’une invite Copilot, commencez par donner Copilot une description générale de l’objectif ou du scénario. Ensuite, répertoriez les exigences spécifiques.

Par exemple :

Copilot prompt
Write a JavaScript function that tells me if a number is prime

The function should take an integer and return true if the integer is prime

The function should error if the input is not a positive integer

Donner des exemples

Utilisez des exemples pour vous aider Copilot à comprendre ce que vous souhaitez. Vous pouvez fournir des exemples de données d’entrée, des exemples de sorties et des exemples d’implémentations.

Par exemple :

Copilot prompt
Write a Go function that finds all dates in a string and returns them in an array. Dates can be formatted like:

* 05/02/24
* 05/02/2024
* 5/2/24
* 5/2/2024
* 05-02-24
* 05-02-2024
* 5-2-24
* 5-2-2024

Example:

findDates("I have a dentist appointment on 11/14/2023 and book club on 12-1-23")

Returns: ["11/14/2023", "12-1-23"]

Les tests unitaires peuvent également servir d’exemples. Avant d’écrire votre fonction, vous pouvez utiliser Copilot pour écrire des tests unitaires pour la fonction. Ensuite, vous pouvez demander Copilot à écrire une fonction décrite par ces tests unitaires.

Diviser les tâches complexes en tâches plus simples

Si vous souhaitez Copilot effectuer une tâche complexe ou volumineuse, divisez la tâche en plusieurs tâches simples et petites.

Par exemple, au lieu de demander Copilot à générer un puzzle de recherche de mots, décomposez le processus en tâches plus petites et demandez-leur Copilot un par un :

  • Écrire une fonction pour générer une grille de lettres de 10 par 10.
  • Écrire une fonction pour rechercher tous les mots dans une grille de lettres, en fonction d’une liste de mots valides.
  • Écrire une fonction qui utilise les fonctions précédentes pour générer une grille de 10 par 10 lettres contenant au moins 10 mots.
  • Mettre à jour la fonction précédente pour imprimer la grille des lettres et 10 mots aléatoires à partir de la grille.

Évitez les ambiguïtés

Évitez les termes ambigus. Par exemple, ne demandez pas ce que cela fait si « cela » peut être le fichier actuel, la dernière Copilot réponse ou un bloc de code spécifique. Dans ce cas, soyez spécifique :

  • Que fait la fonction createUser ?
  • Que fait le code dans votre dernière réponse ?

L’ambiguïté peut également s’appliquer aux bibliothèques :

  • Si vous utilisez une bibliothèque peu courante, décrivez ce qu’elle fait.
  • Si vous souhaitez utiliser une bibliothèque spécifique, définissez les instructions d’importation en haut du fichier ou spécifiez la bibliothèque que vous souhaitez utiliser.

Préciser le code approprié

Si vous utilisez Copilot votre IDE pour obtenir des suggestions au fur et à mesure que vous codez, ouvrez les fichiers pertinents et fermez les fichiers non pertinents. Copilot utilisera les fichiers ouverts pour comprendre votre demande.

Si vous utilisez Discussion avec Copilot votre IDE, ouvrez le fichier ou mettez en surbrillance le code que vous souhaitez référencer Copilot . Vous pouvez également utiliser des mots clés pour fournir manuellement le contexte à Discussion avec Copilot. Par exemple, vous pouvez ajouter le participant à la conversation @workspace dans VS Code, ou @project dans les IDE JetBrains. Consultez Aide-mémoire pour GitHub Copilot Chat.

Expérimentez et itérez

Si vous n’obtenez pas le résultat souhaité, modifiez votre demande et réessayez.

Si vous utilisez Copilot pour obtenir des suggestions à mesure que vous codez, vous pouvez supprimer entièrement la suggestion et recommencer. Vous pouvez également conserver la suggestion et demander des modifications.

Si vous utilisez Discussion avec Copilot, vous pouvez référencer la réponse précédente dans votre requête suivante. Vous pouvez également supprimer la réponse précédente et recommencer.

Conserver un historique pertinent

Discussion avec Copilot utilise l’historique des conversations pour obtenir le contexte de votre demande. Pour ne donner Copilot que l’historique pertinent :

  • utilisez des threads pour démarrer une nouvelle conversation pour une nouvelle tâche ;
  • supprimez les requêtes qui ne sont plus pertinentes ou qui ne vous ont pas donné le résultat souhaité ;

et suivez les bonnes pratiques de codage.

Si vous n’obtenez pas les réponses souhaitées lorsque vous demandez Copilot des suggestions ou des explications dans votre codebase, assurez-vous que votre code existant suit les meilleures pratiques et est facile à lire. Par exemple :

  • utilisez un style et des modèles de code cohérents ;
  • utilisez des noms descriptifs pour les variables et les fonctions ;
  • commentez votre code ;
  • structurez votre code en composants modulaires et délimités ;
  • incluez des tests unitaires.

Utilisez cette méthode Copilot pour aider votre code à suivre les meilleures pratiques. Par exemple, demandez Copilot à ajouter des commentaires ou à interrompre une fonction volumineuse en fonctions plus petites.

Pour approfondir