L’environnement GitHub

GitHub est une plateforme de développement collaboratif massivement utilisée dans le monde logiciel. Elle permet de stocker et de partager du code. Elle est basée sur le système de gestion de version Git.

Cette plateforme est utilisée pour certains exercices du cours pour lesquels la connexion à un compte GitHub est nécessaire.

Important

Pour que votre activité GitHub puisse être prise en compte, votre username doit correspondre à vos identifiants ESIEE.

Si votre adresse mail ESIEE est prenom1-prenom2.nom1-nom2@esiee.fr, vous devez choisir prenom1-prenom2-nom1-nom2 comme username GitHub.

Si vous avez déjà un compte GitHub avec un username différent, vous pouvez changer votre username dans les paramètres de votre compte GitHub.

Pour chaque exercice disponible dans cet environnement, vous devrez :

  • être connecté à votre compte GitHub ;

  • cliquer sur le lien du repo GitHub de l’exercice ;

  • créer une copie de l’exercice dans votre propre espace GitHub en cliquant sur le bouton Use this template et choisir l’option Create a new repository. Vous serez redirigé vers une page de création d’un nouveau repo ;

  • renseigner le champ Repository name avec le nom de l’exercice (par exemple 04-primes) pluis cliquer sur le bouton Create repository;

A cette étape, vous disposez de votre propre repo GitHub 🆁 dont l’URL générique est https://github.com/[YOUR-GITHUB-USERNAME]/[EXERCISE-NAME]. C’est un référentiel qui contient l’ensemble du code, et des fichiers associés à cet exercice. A l’état initial, il contient uniquement le starter code. A l’état final il contiendra votre travail.

Sur la page de ce repo, vous pouvez accéder à l’onglet Code puis cliquer sur Codespaces et Create codespace on master pour créer un environnement de développement dans le cloud. Un codespace 🅲 est un container hébergé par GitHub. Il fait tourner une instance distante de Visual Studio Code dans un environnement Linux. Et comme en local sur votre machine, vous disposez d’un éditeur de code, d’un terminal et d’un navigateur de fichiers. C’est dans cet environnement que vous devrez réaliser l’exercice.

Astuce

Les codespaces sont gérés sur la page https://github.com/codespaces. En version gratuite la ressource est limitée. Veillez à stopper les codespaces que vous n’utilisez pas.

Pour chaque exercice, dans votre codespace 🅲, il faut :

  • lire attentivement la consigne de l’exercice dans le fichier README.md ;

  • ouvrir le fichier main.py ;

  • écrire le code de la fonction secondaire ;

  • écrire quelques appels à la fonction secondaire dans main().

  • exécuter le programme depuis le terminal ;

  • soumettre le code aux tests unitaires : $ pytest .python ;

  • maximiser la qualité du code : $ pylint main.py ;

Une fois les résultats satisfaisants, il faut transférer le travail dans le repo 🆁

$ git add .                             # ajouter tous les fichiers du codespace 🅲 à l'index git
$ git commit -m "message explicatif"    # ajouter les modifications à l'historique du projet
$ git push                              # transférer les modifications sur le repo 🆁

Après cette dernière étape :

  • le codespace 🅲 et le repo 🆁 sont synchronisés ;

  • les détails de l’évaluation du travail sont visibles dans l’onglet Actions du repo 🆁.

Astuce

Il est pratique d’avoir les deux ressources 🅲 et 🆁 ouvertes simultanément dans un navigateur.