Gestion du code et de la documentation (Git/GitHub)
Git et GitHub pour votre projet
Dans ce projet intégrateur, vous devez utiliser Git et GitHub pour gérer l’ensemble de votre travail, pas seulement le code source. Git est un système de gestion de versions qui enregistre l’historique des modifications et permet de revenir à un état précédent en cas de problème.
GitHub est une plateforme en ligne qui héberge vos dépôts Git et facilite le travail en équipe : tout le monde accède au même dépôt, peut récupérer la dernière version, proposer des changements et suivre l’évolution du projet.
Pourquoi utiliser Git pour ce projet ?
- Garder un historique clair de votre projet : chaque commit documente une étape de votre travail (code, docs, tests, etc.), ce qui permet de comprendre l’évolution du projet.
- Pouvoir revenir en arrière si une modification casse quelque chose ou si une idée ne fonctionne pas.
- Faciliter le travail en équipe : chacun peut travailler sur ses tâches sans écraser le travail des autres, puis fusionner les changements.
- Centraliser tous les artefacts du projet au même endroit (code, diagrammes, cahier des charges, tests, etc.), plutôt que de les disperser dans des dossiers locaux ou des pièces jointes.
Structure minimale de votre dépôt
Tous les artefacts de votre projet doivent être versionnés dans un seul dépôt Git. La structure suivante est recommandée pour ce cours :
src/: code source de votre application (projet solution, fichiers .cs, .xaml, etc. selon la technologie utilisée).docs/: documents du projet (diagrammes, cahier des charges, dossier de conception, stratégies de test, plans de tests, documentation utilisateur, etc.).tests/(ou équivalent) : tests automatisés, jeux de données de tests, scripts ou outils de tests, si applicables.- Autres dossiers au besoin (par exemple
scripts/pour des scripts utilitaires), tant que la structure reste claire et cohérente pour l’équipe.
Aucun document important du projet ne doit exister uniquement sur vos machines ou dans Teams / OneDrive : la version de référence doit toujours être celle qui se trouve dans le dépôt Git.
Dépôt GitHub privé pour le projet
Pour ce cours, chaque équipe doit créer un dépôt privé sur GitHub qui sera utilisé comme dépôt central du projet. Git sera utilisé localement par chaque membre, et GitHub servira de point de synchronisation entre vous.
- Créez un dépôt privé sur GitHub pour votre équipe, avec un nom explicite (par exemple
projet-integrateur-equipeX). - Ajoutez tous les membres de votre équipe comme collaborateurs au dépôt pour qu’ils puissent cloner, pousser et créer des branches.
- Ajoutez l’enseignant comme collaborateur avec un rôle lui donnant un accès complet (par exemple « Admin » / plein accès) via Settings → Collaborators / Manage access → Add people.
- Utilisez ce dépôt comme source de vérité : c’est ce dépôt que l’enseignant consultera pour corriger et suivre l’évolution de votre projet.
Attentes minimales d’utilisation
- Commitez régulièrement (plutôt que tout d’un coup à la fin) avec des messages de commit clairs qui décrivent ce que vous avez fait.
- Poussez vos changements sur GitHub fréquemment pour ne pas garder tout le travail uniquement en local.
- Assurez-vous que la structure
src/,docs/et autres dossiers convenus est respectée tout au long du projet. - Utilisez le dépôt GitHub comme support lors de vos rencontres de suivi et remises : tout ce qui est évalué doit pouvoir être retrouvé dans le dépôt.