Obtenir des commentaires sur votre code depuis GitHub Copilot

Découvrez comment demander à GitHub Copilot de passer en revue vos modifications de code et d’appliquer les modifications suggérées.

Dans cet article

À propos du codage collaboratif

Lorsque vous travaillez avec d’autres personnes sur GitHub, vous effectuez généralement vos modifications dans une branche ou une duplication (fork) du projet principal, puis vous les soumettez sous forme de demande de tirage. Une demande de tirage affiche les différences entre le code d’origine et vos modifications, et invite le mainteneur de dépôt à fusionner votre code dans le projet.

Obtenir des commentaires sur votre demande de tirage de la part d’autres personnes est une partie importante du processus de développement logiciel. Les revues des demandes de tirage améliorent le code spécifique sur lequel vous travaillez, tout en améliorant vos compétences en matière de codage et de collaboration au fil du temps. Parfois, surtout lorsque vous apprenez à coder, vous n’avez pas toujours quelqu’un à qui demander des retours. Dans ce cas, vous pouvez obtenir des commentaires et tous leurs avantages grâce à GitHub Copilot.

Une demande de tirage est un espace collaboratif où vous pouvez montrer aux autres les modifications que vous proposez et obtenir des commentaires. Lorsque vous demandez une revue à Copilot, vous vous familiarisez avec le processus que vous utiliserez lorsque vous travaillerez avec des équipes de développement. La seule différence est que vous demanderez également des revues à des collègues humains en plus de Copilot.

Remarque

Révision du code Copilot sur le site web GitHub est une fonctionnalité premium, disponible avec les plans Copilot Pro, Copilot Pro+, Copilot Business et Copilot Enterprise. Pour plus d’informations sur l’impact de l’utilisation de Révision du code Copilot sur vos quotas, consultez Utiliser la revue de code GitHub Copilot. Si vous êtes étudiant, vous pouvez peut-être obtenir Copilot Pro gratuitement, consultez Obtenir un accès gratuit à Copilot Pro en tant qu'étudiant, enseignant ou mainteneur.

1. Création du référentiel de pratique

Dans cet exercice, vous allez utiliser un exemple de référentiel contenant du code existant. L’exemple de référentiel est new2code/grid-toy, un petit projet HTML et JavaScript qui affiche une grille de carrés changeant de couleur. Il s’agit d’un site GitHub Pages et vous pouvez consulter la version originale à l’adresse https://new2code.github.io/grid-toy.

Commencez par créer votre propre copie du référentiel grid-toy.

  1. Accédez à la nouvelle page du référentiel. En suivant ce lien, vous présélectionnerez le modèle sur le compte new2code.
  2. Sous « Propriétaire », sélectionnez votre compte d’utilisateur.
  3. Dans le champ « Nom du référentiel », tapez « grid-toy ».
  4. Cliquez sur Créer un dépôt.

2. Apporter une modification

Ensuite, vous allez apporter une modification au fichier JavaScript.

  1. Dans votre nouveau référentiel, cliquez sur script.js dans la liste des fichiers.

  2. Pour modifier le fichier JavaScript, en haut à droite, cliquez sur .

  3. À la ligne 25, ajoutez le code suivant :

    JavaScript
    if (Math.random() < INVERT_PROBABILITY) {
   cell.classes.add("black");
}

    Cette modification définit de manière aléatoire certains carrés de la grille en noir lors du chargement de la page. Une erreur a été introduite délibérément afin de déclencher un retour de la part de GitHub Copilot : la propriété correcte est en réalité .classList et non .classes. GitHub Copilot devrait nous aider à résoudre ce problème.

  4. Pour commiter la modification, en haut à droite, cliquez sur Commiter les modifications...

  5. Dans le champ « Message de commit », entrez quelque chose comme « Définir des carrés aléatoirement au chargement ».

  6. Sélectionnez Créer une branche pour cette validation, puis lancer une demande de tirage.

  7. Cliquez sur Proposer des modifications.

3. Créer une demande de tirage et demander une revue

Terminez maintenant la demande de tirage et demandez une revue.

  1. Saisissez un titre et, si vous le souhaitez, une description pour votre demande de tirage.
  2. Cliquez sur Réviseurs.
    • Si Copilot apparaît dans la liste suggérée, cliquez sur « Copilot ».
    • Si ce n’est pas le cas, commencez à taper « Copilot », puis cliquez sur le résultat.
  3. Cliquez sur ** Créer une demande de tirage**.

Vous serez redirigé vers votre nouvelle demande de tirage.

4. Appliquer une modification suggérée

En quelques minutes, GitHub Copilot passera en revue votre demande de tirage, produira un résumé et créera des suggestions de modifications pour tout problème détecté.

  1. Attendez que la revue effectuée par GitHub Copilot apparaisse.

  2. L’une de ces suggestions devrait corriger l’erreur volontaire introduite précédemment en remplaçant .classes par .classList. Sous la suggestion de modification, cliquez sur Commiter la suggestion.

    Capture d’écran d’une modification suggérée à partir de GitHub Copilot. Le bouton « Commiter la suggestion » est mis en évidence par un contour orange.

  3. Cliquez sur Valider les changements.

  4. Il est possible que GitHub Copilot ait trouvé d’autres améliorations et laissé des commentaires supplémentaires. Si vous comprenez les modifications suggérées, vous pouvez également les appliquer.

5. Fusion

Une fois que vous êtes satisfait des modifications, vous pouvez fusionner la demande de tirage. Les modifications de votre branche sont alors ajoutées à la branche par défaut du référentiel (main).

  1. Au bas de la page, cliquez sur Fusionner la demande de tirage.
  2. Vous pouvez également mettre à jour le message de commit.
  3. Appuyez sur Confirmer la fusion.

Étapes suivantes

Le projet peut être publié à l’aide de GitHub Pages. Maintenant que vous avez apporté quelques modifications, vous pouvez publier votre version du référentiel pour la voir en action. Consultez Configuration d’une source de publication pour votre site GitHub Pages.