Skip to content
jean-ely.gendrau edited this page Jul 2, 2024 · 26 revisions

🌟 Guide GitHub pour le Développement de ce repositorie d'Extensions Google Chrome

Ce guide vous aidera à démarrer avec GitHub pour développer votre première extension Google Chrome. Vous apprendrez à créer des branches, à gérer les issues, à pousser vos modifications et à faire des demandes de tirage (pull requests).

🚀 Étapes Initiales

Warning

Remplacer les valeur sivante: USERNAME par le votre USERNAME GitHub my-extension par le nom de votre repositorie

Utilisez l'outil CLI de GitHub gh pour créer votre repository :

Tip

Pour utiliser l'outil CLI de GitHub il faut être authentifié S'authentifié avec la CLI gh auth login

1. Créer le Repository GitHub

Utilisez l'outil CLI de GitHub gh pour créer votre repository :

gh repo create my-extension --public --description "Votre première extension Google Chrome"

2. Cloner le Repository

Clonez le repository que vous venez de créer :

git clone https://github.com/USERNAME/my-extension.git
cd my-extension

3. Créer les Issues

Créez les issues nécessaires pour suivre les étapes de développement :

  • Initialisation de la Structure de l'Extension :
gh issue create --title "initialiser/Réaliser La première extension" --body "https://github.com/USERNAME/my-extension/issues/1"
  • Mise en Service et Test de l'Extension :
gh issue create --title "Mise en Service et Test de l'Extension" --body "https://github.com/USERNAME/my-extension/issues/2"

Félicitations ! Vous avez créé vos deux premières issues de projet. Cela facilitera le travail de développement pour vous ou votre équipe, si vous travaillez en groupe. Maintenant, il est important de créer une milestone pour organiser et structurer les étapes cruciales du développement.

Une milestone vous permet de regrouper plusieurs issues liées à une même phase du projet, rendant ainsi le suivi et la gestion plus efficaces. Pour créer une milestone sur GitHub :

  • Accédez à l'onglet "Issues" de votre dépôt.
  • Cliquez sur "Milestones" et ensuite sur "New milestone".
  • Donnez un titre clair et descriptif à votre milestone.
  • Ajoutez une description détaillée pour expliquer les objectifs de cette étape.
  • Définissez une date d'échéance si nécessaire.

4. Ensuite, associez vos issues à la milestone créée. Pour cela :

  • Ouvrez chaque issue que vous souhaitez inclure.
  • Dans la section "Milestone" à droite, sélectionnez la milestone appropriée.
  • Vous pouvez également utiliser le symbole # dans les commentaires ou descriptions pour lier directement d'autres issues ou pull requests.

En suivant ces étapes, vous pourrez mieux gérer et suivre l'avancement de votre projet.

5. Créer une Branche de Développement

Il est recommandé de créer une branche de développement pour isoler votre travail de la branche principale (main). Cela vous permet de tester et de développer de nouvelles fonctionnalités sans affecter la version stable de votre projet.

git checkout -b dev
git push --set-upstream origin dev

6. Créer des Branches pour les Issues

Pour chaque issue, créez une branche distincte à partir de la branche dev. Cela aide à organiser votre travail et à rendre les modifications plus faciles à suivre et à gérer.

  • Initialisation de la Structure de l'Extension :
git checkout -b feat/initial-structure dev

Voir les Tâches à effectué dans la branche feat/initial-structure

Warning

Passé à l'étape 7. Pousser les Modifications vers GitHub avant de créer la branche suivante.

- Mise en Service et Test de l'Extension :

git checkout -b feat/service-test dev

Voir les Tâches à effectué dans la branche feat/service-test

Puis continuer.

7. Pousser les Modifications vers GitHub

Une fois que vous avez fait des changements dans votre branche, vous devez les ajouter, les committer et les pousser vers GitHub.

- Pull Request Branch feat/initial-structure

git push origin feat/initial-structure

- Pull Request Branch feat/service-test

git push origin feat/service-test

8. Faire une Demande de Tirage (Pull Request)

Après avoir poussé vos modifications, allez sur GitHub et créez une pull request pour fusionner votre branche dans dev.

  • Allez sur la page de votre repository sur GitHub.
  • Cliquez sur le bouton Compare & pull request à côté de votre branche récemment poussée.
  • Remplissez les détails nécessaires et cliquez sur Create pull request.

Félicitations ! Vous avez fusionné avec succès les modifications de la branche feat/initial-structure dans la branche dev.

Maintenant, retournez à la branche de développement et mettez-la à jour pour intégrer les derniers changements 👍 👍

git switch dev && git pull

9. Répéter les Étapes pour les Autres Issues

Félicitation vous venez de réaliser la première étape de développement, avant de fusionné en branche main, nous allons effectué la deuxième étape(Issue #2). Reprendre à l'étape 6 Mise en Service et Test de l'Extension

Tip

Dans un projet collaboratif comportant plusieurs tâches à réaliser, vous devrez répéter les étapes 3 à 5 pour chaque issue que vous créez.

🔄 Fusionner les Changements dans la Branche main

Une fois que toutes les fonctionnalités ont été développées et testées dans la branche dev, vous pouvez créer une pull request pour fusionner dev dans main.

  • Allez sur la page de votre repository sur GitHub.
  • Cliquez sur le bouton Compare & pull request à côté de la branche dev.
  • Remplissez les détails nécessaires et cliquez sur Create pull request.

🎉 Félicitations !

Vous avez maintenant les compétences nécessaires pour développer, gérer et collaborer sur des projets GitHub. Bon développement et amusez-vous bien avec votre première extension Google Chrome !