Skip to content

Latest commit

 

History

History
157 lines (109 loc) · 8.6 KB

gestion_projet_data.md

File metadata and controls

157 lines (109 loc) · 8.6 KB

Gestion de Projet Data sur GitHub

Dans cette fiche technique, nous allons détailler les étapes de gestion d’un projet Data en utilisant GitHub. De la naissance de l’idée à la phase de livraison, en passant par la gestion des versions, des tâches, et des équipes, chaque étape sera abordée pour permettre une gestion fluide et structurée de ton projet. Ce guide est conçu pour être utilisé dans tous types de projets Data, que ce soit pour des projets individuels ou collaboratifs.

1. Lancement du Projet Data

1.1 De l’Idée au Projet

Lorsque l’idée du projet naît, il est essentiel de poser les bases pour garantir son succès. Voici les étapes à suivre :

  • Définir l’objectif : Quel est l’objectif du projet ? Quelles sont les questions auxquelles il doit répondre ?
  • Identification des ressources : Quelles données sont nécessaires ? Quelles compétences techniques (Python, SQL, etc.) sont requises ?
  • Planification préliminaire : Une première ébauche de planification est importante pour déterminer le déroulement du projet, notamment les étapes critiques et les délais associés.

À cette étape, un fichier README.md doit être créé dans ton repository GitHub pour introduire ton projet.

Contenu à inclure dans le README.md :

  • Présentation du projet : Brève description et objectifs.
  • Technologies utilisées : Liste des outils et bibliothèques (ex : Python, Pandas, Scikit-learn).
  • Instructions d’installation : Décrire les étapes pour configurer l’environnement (ex : pip install -r requirements.txt).
  • Exemples d’utilisation : Donne des exemples pratiques d’utilisation de ton projet.

1.2 Création du Repository GitHub

Une fois l’idée définie, la création du repository GitHub est la prochaine étape :

  • Nom du repository : Choisis un nom clair et représentatif du projet.
  • Initialisation du repository : Crée le repository en y ajoutant un fichier README.md, un .gitignore, et un fichier de dépendances (requirements.txt ou environment.yml).
  • Structure initiale : Pense à organiser ton repository de manière logique dès le départ (dossiers src, docs, notebooks, etc.).

Exemple d’organisation de base :

/project-root  
│  
├── /docs             # Documentation du projet  
├── /src              # Code source principal  
├── /notebooks        # Notebooks Jupyter pour l'analyse exploratoire  
├── /data             # Données brutes ou transformées  
│  
├── requirements.txt  # Liste des dépendances du projet  
├── README.md         # Description du projet  
└── .gitignore        # Fichiers et dossiers à exclure du contrôle de version

2. Planification du Projet

2.1 Création des Issues et Milestones

Les issues et milestones permettent de suivre l’avancement du projet et de gérer les tâches efficacement.

Issues :

Les issues représentent des tâches ou des bugs à résoudre dans le projet. Elles peuvent être liées à des fonctionnalités spécifiques, à des tests, ou à des étapes de développement.

Étapes pour créer une issue :
  1. Aller dans l'onglet Issues de ton repository GitHub.
  2. Cliquer sur New issue.
  3. Donner un titre clair et une description détaillée de la tâche.
  4. Assigner des labels (ex : bug, feature, documentation).
  5. Assigner l'issue à une personne spécifique ou à toi-même.

Exemples de titres d'issues :

  • Nettoyage des données : Script pour nettoyer les données manquantes.
  • Entraînement du modèle : Créer le script d’entraînement du modèle de prédiction.

Milestones :

Les milestones servent à définir des objectifs à long terme dans ton projet, comme des versions majeures du projet (par exemple, version MVP, version Alpha, version finale).

Créer un milestone :
  1. Aller dans l'onglet Milestones de ton repository.
  2. Cliquer sur Create a new milestone.
  3. Définir un titre (ex : MVP, v1.0, etc.), une description, et une date de fin estimée.
  4. Associer les issues pertinentes à ce milestone.

Exemples de milestones :

  • MVP : Version avec les fonctionnalités de base et les premiers résultats.
  • Version finale : Version stable du projet prête à être déployée.

2.2 Utilisation de GitHub Projects pour le Suivi des Tâches

GitHub propose une fonctionnalité appelée Projects, permettant d’organiser les issues et les milestones sous forme de tableaux kanban. Cela permet de suivre visuellement l’avancement des tâches.

Étapes pour créer un Project :
  1. Aller dans l'onglet Projects.
  2. Cliquer sur New Project et choisir un tableau kanban.
  3. Créer des colonnes comme : To do, In progress, Done.
  4. Ajouter des issues aux colonnes correspondantes.

3. Développement du Projet

3.1 Utilisation des Branches et Pull Requests

Dans un projet collaboratif ou même personnel, l’utilisation des branches et des pull requests (PR) est essentielle pour garder une organisation claire et stable du code.

Création de branches :

  • Crée des branches pour chaque nouvelle fonctionnalité ou tâche.
    • Exemple de branche pour une fonctionnalité : feature/entraînement_du_modèle
    • Exemple de branche pour un bugfix : bugfix/correction_erreur_donnees

Pull Requests (PR) :

Les pull requests permettent de soumettre des modifications pour revue avant de les fusionner avec la branche principale (main).

Étapes pour créer une pull request :
  1. Aller dans l'onglet Pull Requests de GitHub.
  2. Cliquer sur New pull request.
  3. Comparer la branche source et la branche de destination (main).
  4. Ajouter un titre et une description pour expliquer les modifications.
  5. Demander une revue de code si nécessaire.

4. Phase de Test et Validation

4.1 Tests et Documentation

Il est important d'inclure des tests unitaires dans ton projet pour valider les fonctionnalités. Tu peux utiliser des outils comme Pytest ou unittest pour automatiser les tests.

Structure des tests :

  • Test des fonctions : Tester les fonctions principales du projet (ex : nettoyage des données, entraînement des modèles).
  • Test d’intégration : Vérifier l'intégration des différentes parties du projet (par exemple, la préparation des données et la création du modèle).
  • Test de performance : S'assurer que le projet fonctionne efficacement (ex : temps d'exécution des modèles).

Les tests peuvent être placés dans un dossier tests/ à la racine du repository.

4.2 Création de la Documentation Finale

Une fois le projet terminé, la documentation doit être complète et bien structurée. Cela inclut :

  • Instructions d’installation : Rappeler comment configurer l’environnement.
  • Guide d’utilisation : Expliquer comment utiliser le projet, avec des exemples et des captures d'écran si nécessaire.
  • Dépendances : Liste de toutes les bibliothèques et outils utilisés.
  • Notes sur les versions : Mentionner les principales modifications de chaque version du projet (ex : dans un fichier CHANGELOG.md).

5. Livraison et Suivi Post-Livraison

5.1 Version Finale (Production)

Une fois que le projet est testé et validé, il est temps de le préparer pour la production. Si ton projet inclut un modèle, assure-toi qu'il est optimisé et prêt à être déployé. Prépare également un script de mise en production si nécessaire.

Tagging :

Crée un tag dans GitHub pour marquer la version finale du projet.

  1. Aller dans l'onglet Releases de ton repository.
  2. Cliquer sur Draft a new release.
  3. Ajouter un tag (ex : v1.0.0) et une description de la version.

5.2 Maintenance et Évolutions

Après la livraison, le projet devra être suivi pour corriger les bugs, ajouter des améliorations, ou répondre aux retours des utilisateurs. Utilise des issues pour signaler des problèmes ou des fonctionnalités supplémentaires.

6. Conclusion

La gestion d’un projet Data sur GitHub, que ce soit pour un projet individuel ou collaboratif, repose sur une organisation claire et une gestion efficace des tâches et des versions. Utiliser les outils de GitHub comme les issues, les milestones, et les projects permet de structurer le projet de manière fluide et d'assurer sa bonne progression. La création de branches pour chaque fonctionnalité et l’utilisation de pull requests pour réviser le code sont des pratiques essentielles pour maintenir la qualité du code tout au long du projet.