Création d'un README soigné avec GitHub Copilot

Ouvrir ou créer votre fichier README

Votre première étape consiste à ouvrir le fichier spécial README.md de votre projet. S’il n’existe pas encore, vous devrez le créer. L’extension .md indique qu’il s’agit d’un fichier Markdown, un format simple pour mettre en forme du texte (titres, listes, gras, etc.) que GitHub comprend.

Pour cela, regardez le volet Explorateur sur le côté gauche de votre fenêtre VS Code – il affiche tous les fichiers et dossiers de votre projet. Si vous ne le voyez pas, appuyez sur Ctrl + Shift + E (sur Windows/Linux) ou Cmd + Shift + E (sur Mac) pour le faire apparaître.

Action : Dans le volet Explorateur, faites un clic droit sur le dossier principal de votre projet, puis choisissez « New File ». Tapez README.md exactement comme indiqué et appuyez sur Enter.
Ce que vous voyez : Un nouveau champ de saisie apparaît pour le nom du fichier dans le volet Explorateur.
Ce qui se passe ensuite : Le nouveau fichier README.md s’ouvrira comme document vierge dans la zone principale de l’éditeur de VS Code.
Si cela diffère : Si vous avez déjà un fichier README.md, cliquez simplement dessus dans le volet Explorateur pour l’ouvrir, puis supprimez le texte existant si vous voulez repartir de zéro pour ce guide.

Vous saurez que cela a fonctionné lorsque un fichier vierge nommé README.md apparaît dans la zone principale de l’éditeur de VS Code, prêt à recevoir votre texte.

Commencer la description de votre projet

Maintenant que votre fichier README.md est ouvert, nous demanderons à Copilot d’aider à rédiger la description principale. GitHub Copilot utilise ce qu’on appelle « l’autocomplétion », qui ressemble à la saisie prédictive de votre téléphone, mais en beaucoup plus intelligent. Il s’appuie sur l’intelligence artificielle (IA) pour deviner ce que vous voulez écrire ensuite en fonction du contexte.

Action : Placez votre curseur clignotant sur la toute première ligne de votre fichier README.md, tapez un court titre pour votre projet, puis appuyez sur la touche Enter.
Ce que vous voyez : Après avoir tapé le titre, une suggestion en gris clair de Copilot apparaît généralement juste après votre curseur.
Ce qui se passe ensuite : Copilot lira votre court titre et commencera automatiquement à suggérer un paragraphe complet décrivant votre projet. Si la suggestion vous convient, appuyez sur la touche Tab pour l’accepter. Si vous voulez une autre option, appuyez sur Ctrl + Space (sur Windows/Linux) ou Option + Space (sur Mac) pour parcourir différentes suggestions jusqu’à en trouver une qui vous plaît.
Si cela diffère : Si Copilot ne propose pas de suggestion immédiatement, assurez‑vous que l’extension GitHub Copilot est activée (vérifiez l’icône Copilot en bas à droite de VS Code). Vous pouvez aussi essayer de taper quelques mots supplémentaires avant d’appuyer de nouveau sur Enter.

Vous saurez que cela a fonctionné lorsque Copilot présente une suggestion de texte gris clair directement dans votre éditeur, et que vous avez accepté la description en appuyant sur Tab.

Générer un guide d’installation

La plupart des projets requièrent des instructions d’installation. Copilot peut également générer ces sections courantes. Il devine intelligemment le langage de programmation de votre projet à partir des autres fichiers du dépôt, et propose les commandes appropriées.

Action : Déplacez votre curseur quelques lignes plus bas (appuyez plusieurs fois sur Enter pour créer de l’espace), tapez ## Installation, appuyez sur Enter, puis saisissez une courte invite comme Run the following command: et appuyez sur Enter.
Ce que vous voyez : Votre nouveau titre, suivi de votre indication, puis une suggestion en gris clair pour une commande d’installation.
Ce qui se passe ensuite : Copilot complétera automatiquement une commande de terminal comme npm install (pour les projets JavaScript) ou pip install -r requirements.txt (pour les projets Python).
Si cela diffère : Si la commande suggérée ne correspond pas au langage ou au gestionnaire de paquets de votre projet, supprimez‑la et saisissez une indication plus précise. Par exemple, Install Python dependencies: si Copilot a proposé npm install pour un projet Python.

Vous saurez que cela a fonctionné lorsque Copilot propose une ligne de commande d’installation et que vous l’avez acceptée en appuyant sur Tab.

Ajouter un exemple d’utilisation

Une fois le projet installé, il faut expliquer comment l’utiliser ! Nous allons suivre un schéma similaire pour que Copilot génère une commande de démarrage de votre application.

Action : Après la section d’installation, déplacez votre curseur quelques lignes plus bas, tapez ## Usage, appuyez sur Enter, puis écrivez une brève instruction comme Start the app with: et appuyez sur Enter.
Ce que vous voyez : Votre nouveau titre et votre indication, suivis de la suggestion de Copilot.
Ce qui se passe ensuite : Copilot proposera une commande telle que npm start ou python app.py, en fonction de ce qu’il a déduit de votre projet. Acceptez la bonne commande en appuyant sur Tab.
Si cela diffère : Si la commande proposée est légèrement inexacte, vous pouvez l’accepter puis la modifier manuellement pour l’adapter à votre projet. Vous pouvez également ajouter une courte description en français sous la commande, par exemple : « Cela lance le serveur local sur http://localhost:5000 ».

Vous saurez que cela a fonctionné lorsque Copilot propose une commande pour lancer votre projet et que vous l’avez acceptée.

Inclure un aperçu du projet

Un bon README se conclut souvent par un bref résumé des objectifs du projet ou des technologies clés utilisées. Faisons générer à Copilot un aperçu rapide.

Action : Descendez de quelques lignes depuis la section usage, tapez ## Overview, appuyez sur Enter, puis saisissez quelques mots descriptifs comme This project demonstrates... et appuyez sur Enter.
Ce que vous voyez : Votre nouveau titre ## Overview, suivi de votre indication, puis une suggestion de résumé plus détaillé de Copilot.
Ce qui se passe ensuite : Copilot remplira un paragraphe concis qui résume le but et les points forts de votre projet.
Si cela diffère : Si le résumé est trop vague, ajoutez des mots‑clés plus spécifiques à votre indication initiale (par ex., This project demonstrates data fetching and UI components...) pour orienter Copilot vers une réponse plus ciblée.

Vous saurez que cela a fonctionné lorsque Copilot vous donne un court paragraphe descriptif résumant votre projet, que vous pouvez alors accepter.

Finaliser avec une mention de licence

Il est d’usage de préciser la licence de votre projet. Cela indique aux autres comment ils peuvent utiliser, modifier et distribuer votre code. La licence MIT est un choix très répandu et permissif pour les projets open‑source.

Action : Sous la section Overview, ajoutez un nouveau titre en tapant ## License, puis appuyez sur Enter. Sur la ligne suivante, tapez This project is licensed under the MIT License.
Ce que vous voyez : Le nouveau titre et la mention de licence apparaissent dans votre fichier README.md.
Ce qui se passe ensuite : Vous avez maintenant complété les sections essentielles de votre README. Copilot ne générera généralement pas le texte complet d’une licence à moins d’une demande très précise, il est donc judicieux d’ajouter manuellement le texte standard.
Si cela diffère : Si vous avez besoin d’une autre licence, recherchez en ligne le texte correspondant (par ex., « Apache 2.0 License text ») et copiez‑le dans cette section.

Vous saurez que cela a fonctionné lorsque la section ## License est visible et complète dans votre fichier README.md.