Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bts-lasalle-avignon-ressources/guide-classroom
Guide pour les travaux pratiques sur Github Classroom
https://github.com/bts-lasalle-avignon-ressources/guide-classroom
Last synced: about 1 month ago
JSON representation
Guide pour les travaux pratiques sur Github Classroom
- Host: GitHub
- URL: https://github.com/bts-lasalle-avignon-ressources/guide-classroom
- Owner: bts-lasalle-avignon-ressources
- Created: 2024-02-18T08:39:35.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-18T10:29:50.000Z (11 months ago)
- Last Synced: 2024-02-18T12:30:47.644Z (11 months ago)
- Size: 7.83 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Guide Github Classroom
Une présentation de la plateforme [Github Classroom](https://classroom.github.com/) qui permet de gérer des devoirs dans une salle de classe et surtout de les automatiser. On retrouve des [modèles de TP](#des-modèles-de-devoir) avec notation automatique sous forme de badges pour de nombreux langages (bash, C++, Java, PHP, Python, Javascript, Dart, Go) et _frameworks_ (Qt, Android, PlatformIO, Flutter).
- [Guide Github Classroom](#guide-github-classroom)
- [GitHub Classroom](#github-classroom)
- [Créer un modèle de dépôt](#créer-un-modèle-de-dépôt)
- [Créer une classe](#créer-une-classe)
- [Créer un devoir](#créer-un-devoir)
- [Le devoir](#le-devoir)
- [_Feedback_](#feedback)
- [Extension Visual Studio Code](#extension-visual-studio-code)
- [Un devoir avec auto-test](#un-devoir-avec-auto-test)
- [Des modèles de devoir](#des-modèles-de-devoir)
- [Aperçus](#aperçus)
- [Auteurs](#auteurs)
---
## GitHub Classroom
[Github](https://github.com/) a un programme pour l'[éducation](https://docs.github.com/fr/education) qui comprend l'(excellent) outil [Github Classroom](https://classroom.github.com/).
[GitHub Classroom](https://classroom.github.com/) automatise la création et le contrôle d'accès de dépôts [GitHub](https://github.com/) pour l'enseignement. [GitHub Classroom](https://classroom.github.com/) s'adresse aux étudiants pour récupérer un code de démarrage et aux enseignants pour la collecte des devoirs.
[GitHub Classroom](https://classroom.github.com/) est gratuit pour tous. Il est possible aussi de profiter des avantages de [GitHub Education](https://education.github.com/) (étudiants et enseignants).
https://fr.wikipedia.org/wiki/GitHub[GitHub] est un service web d'hébergement et de gestion de développement de logiciels, utilisant le logiciel de gestion de versions Git.
[Git](https://fr.wikipedia.org/wiki/Git) est un logiciel de **gestion de versions décentralisé** (DVCS). C'est un logiciel libre créé par *Linus Torvalds* en 2005. Il s'agit maintenant du logiciel de gestion de versions le plus populaire devant [Subversion](https://fr.wikipedia.org/wiki/Apache_Subversion) (`svn`) qu'il a remplacé avantageusement.
Sites officiels :
- [GitHub Classroom](https://classroom.github.com/)
- [GitHub Education](https://docs.github.com/en/education)
- [GitHub](https://github.com/)
- [Git](https://git-scm.com/)
Documentation : [Manage coursework with GitHub Classroom](https://docs.github.com/en/education/manage-coursework-with-github-classroom)
Tutoriels : [Basics of setting up Github Classroom](https://docs.github.com/fr/education/manage-coursework-with-github-classroom/get-started-with-github-classroom/basics-of-setting-up-github-classroom)
### Créer un modèle de dépôt
Il faut créer préalablement un dépôt (_repository_) dans [GitHub](https://github.com/) :
Puis le paramètrer en "modèle" (_template_):
### Créer une classe
On commence par créer une nouvelle classe (_classroom_) :
Exemple :
> [!NOTE]
> On pourra ensuite créer des devoirs (_assignments_) pour cette classe.
Les étudiants de cette classe :
On peut connecter un système de gestion de cours comme [Google Classroom]https://classroom.google.com/) ou importer une liste des étudiants au format CSV.
Et les enseignants et administrateurs :
L'onglet _Settings_ permet notamment de connecter un système de gestion de cours comme [Google Classroom](https://classroom.google.com/) (afin de récupèrer la liste des étudiants) :
On se connecte à [Google Classroom](https://classroom.google.com/) :
Et on sélectionne un cours :
[GitHub Classroom](https://classroom.github.com/) récupère la liste des étudiants ce qui facilitera l'attibution des devoirs par la suite.
### Créer un devoir
On peut créer des devoirs (_assignments_) individuels ou de groupe :
> [!NOTE]
> Pour un devoir individuel, GitHub Classroom nomme les dépôts par le préfixe du dépôt du devoir et le nom d'utilisateur GitHub de l'étudiant. Un devoir de groupe est un travail de cours collaboratif pour des groupes d'étudiants sur GitHub Classroom. Les étudiants pourront travailler ensemble sur un devoir de groupe dans un dépôt partagé, comme une équipe de développeurs professionnels.
On sélectionne ensuite le modèle de dépôt :
On termine la création :
On obtient une invitation que l'on peut partager avec les étudiants concernés :
### Le devoir
L'étudiant accepte le devoir :
Et il est prêt à "travailler" sur le dépôt :
GitHub a créé un dépôt privé dans l'organisation :
Le nom du dépôt possède en suffixe le nom du compte GitHub de l'étudiant :
Le dépôt contient une copie du dépôt "modèle" :
L'enseignant reçoit un email confirmant l'inscription de l'étudiant au devoir :
L'enseignant "voit" (et peut accèder à) l'ensemble des devoirs étudiants (et l'évolution des _commits_) et peut récupérer l'ensemble des dépôts (_Download Repositories_) :
Pour récupérer les travaux, [GitHub Classroom](https://classroom.github.com/) fournit un [assistant](https://classroom.github.com/assistant) pour Windows(C), MacOS(C) et Linux.
Ou directement à partir de l'outil :
On sélectionne ensuite les travaux à récupérer :
On peut préciser le chemin de stockage de l'archive :
On obtient :
### _Feedback_
Lors de la création du devoir, il est possible d'y associer une _Pull Request_ pour assurer une communication Étudiant/Enseignant sur ce devoir :
On reçoit alors un email :
La _Pull Request_ dans GitHub :
Elle permet :
### Extension Visual Studio Code
[Visual Studio Code](https://code.visualstudio.com/) possède une extension dédiée à [GitHub.classroom](https://marketplace.visualstudio.com/items?itemName=GitHub.classroom).
Elle permet de parcourir les devoirs et de commencer à travailler dessus. Elle apparaît dans l'onglet de l'extension [GitHub.vscode-pull-request-github](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github) et il faut commencer par s'authentifier. La liste des devoirs apparaît alors dans l'arborescence.
### Un devoir avec auto-test
Il est possible de configurer un devoir avec des tests exécutés automatiquement pour chaque soumission (`push`) de code dans le dépôt.
[GitHub Actions](https://docs.github.com/en/actions) exécutera les commandes pour le test automatique dans un environnement Linux contenant le code le plus récent de l'étudiant. Il est possible d'y associer des points pour obtenir une note finale pour le devoir.
Lien : [Use autograding](https://docs.github.com/en/education/manage-coursework-with-github-classroom/teach-with-github-classroom/use-autograding)
Il est possible d'ajouter des tests à la création du devoir ou plus tard en l'éditant :
Il existe deux méthodes distinctes : les tests d'entrée/sortie et les tests de commande d'exécution.
Un test de commande d'exécution :
Un test d'entrée/sortie :
On peut suivre l'exécution du test dans GitHub Actions :
//
Et dans Classroom :
Ici, le test n'est pas passé :
Les détails dans GitHub Actions :
Pour les tests de commande d'exécution, il est intéressant d'y associer des *tests unitaires*.
Il y a une exemple fourni pour C++ avec `make` et [Catch2](https://github.com/catchorg/Catch2).
[Autograding Example C++](https://github.com/education/autograding-example-cpp)
## Des modèles de devoir
Chaque exemple de devoir intègre la notation automatique avec sa visualisation sous forme de badge :
- 
https://github.com/btssn-lasalle84/tp-poo-cpp
-   
https://github.com/btssn-lasalle84/tp-script-bash
-   
https://github.com/btssn-lasalle84/tp-poo-cpp
https://github.com/btssn-lasalle84/tp-poo-qt
https://github.com/btssn-lasalle84/tp-poo-platformio
-  
https://github.com/btssn-lasalle84/tp-poo-java
https://github.com/btssn-lasalle84/tp-poo-android
- 
https://github.com/btssn-lasalle84/tp-poo-python
- 
https://github.com/btssn-lasalle84/tp-poo-php
- 
https://github.com/btssn-lasalle84/tp-poo-javascript
-  
https://github.com/btssn-lasalle84/tp-poo-dart
https://github.com/btssn-lasalle84/tp-poo-flutter
- 
https://github.com/btssn-lasalle84/tp-poo-go
## Aperçus
Ma salle de classe pour cette année :
La vue d'ensemble pour un devoir :
Le dépôt privé d'un étudiant automatiquement créé par [Github Classroom](https://classroom.github.com/) avec l'évolution de la note à chaque _commit/push_ :
Chaque _commit/push_ déclenche un _workflow_ dans Github Actions :
Lors de la création du devoir, il est possible d’y associer une _Pull Request_ _Feedback_ pour assurer une communication Étudiant/Enseignant sur ce devoir (mettre des commentaires et/ou répondre aux questions d’un étudiant) :
Les devoirs sont hébergés dans une organisation :
## Auteurs
- [Thierry VAIRA]([email protected]) : [tvaira.free.fr](http://tvaira.free.fr/)
---
©️ 2023 BTS LaSalle Avignon