Github Fork - Comment contribuer à un projet GitHub

Vue d’ensemble

Vous débutez dans la contribution communautaire ? Vous avez trouvé un problème dans un dépôt GitHub ou souhaitez ajouter une nouvelle fonctionnalité et la proposer aux propriétaires du dépôt ? Cet article est fait pour vous. En seulement 4 minutes, vous apprendrez comment forker un dépôt, le cloner localement et publier votre première Pull Request.

Étape 1 : Forker un dépôt

La première étape pour contribuer à un projet GitHub est de forker le dépôt. Cela crée une copie du dépôt original dans votre propre compte GitHub. Pour ce faire :

1. Allez sur la page du dépôt que vous souhaitez forker.
2. Cliquez sur le bouton “Fork” en haut à droite de la page.
3. Sélectionnez votre compte GitHub comme destination pour le fork.

Si vous souhaitez travailler sur une branche autre que cette par défaut (main, master, dev), vous devez décocher la case “Copy the main branch only” présente en bas de la page.

Étape 2 : Cloner le dépôt localement

Une fois que vous avez forké le dépôt, vous devez cloner cette copie sur votre machine locale pour pouvoir y apporter des modifications. Voici comment procéder :

1. Allez sur la page de votre depot (fork) sur GitHub.
2. Cliquez sur le bouton “Code” et copiez l’URL du dépôt.

3. Ouvrez votre terminal et exécutez la commande suivante :

   git clone [URL_du_dépôt]
   

   Remplacez [URL_du_dépôt] par l’URL que vous avez copiée.

Étape 3 : Créer une nouvelle branche

Avant d’apporter des modifications, il est recommandé de créer une nouvelle branche. Cela permet de garder votre branche principale propre et de faciliter la gestion des modifications. Pour créer une nouvelle branche, exécutez les commandes suivantes dans votre terminal :

cd [nom_du_dépôt]
git checkout [nom_de_la_branche]

Remplacez [nom_du_dépôt] par le nom de votre dépôt et [nom_de_la_branche] par un nom descriptif pour votre branche.

Étape 4 : Apporter des modifications et les committer

Maintenant que vous êtes sur une nouvelle branche, vous pouvez apporter les modifications nécessaires. Une fois les modifications effectuées, vous devez les committer. Voici comment faire :

git add .
git commit -m "Description de vos modifications"

Étape 5 : Pousser les modifications vers GitHub

Après avoir committé vos modifications, vous devez les pousser vers votre fork sur GitHub. Utilisez la commande suivante :

git push origin [nom_de_la_branche]

Étape 6 : Créer une Pull Request

Enfin, pour proposer vos modifications aux propriétaires du dépôt original, vous devez créer une Pull Request. Pour ce faire :

1. Allez sur la page de votre fork sur GitHub.
2. Cliquez sur le bouton “Compare & pull request”.
3. Ajoutez une description de vos modifications et cliquez sur “Create pull request”.

Synchronisation

Votre Fork et le dépôt original ne sont pas automatiquement mis à jour. Pour cela, vous devez allez sur la page de votre fork sur GitHub et appuyer sur le bouton de Synchronisation.