GitubSession

Contribution aux projets open source utilisant GIT

Bienvenue dans notre projet! Nous sommes ravis que vous envisagiez de contribuer au développement open source. Ce guide vous guidera à travers les commandes GIT et les meilleures pratiques essentielles pour rendre votre contribution facile et réussie.

Table des matières

1. Faire le référentiel
2. Cloner le référentiel
3. Créer une branche
4. Apporter des changements
5. Commettre des changements
6. Pousser les changements
7. Créer une demande de traction
8. Synchronisation de votre fourchette
9. Conseils pour écrire de bons messages de validation

---

1. Fifler le référentiel

Avant de commencer à contribuer, vous devez déborder le référentiel. La forking crée une copie du référentiel sous votre propre compte GitHub.

Mesures:

1. Accédez à la page du référentiel.
2. Cliquez sur le bouton "Fork" dans le coin supérieur droit.
3. Vous aurez maintenant une copie du référentiel dans votre compte GitHub.

---

2. Clonage du référentiel

Après avoir fourni le référentiel, vous devez le cloner sur votre machine locale afin que vous puissiez y travailler.

git clone https://github.com/your-username/repository-name.git

---

3. Création d'une branche

Après le clonage du référentiel, créez une nouvelle branche pour travailler sur vos modifications. Travaillez toujours dans une branche séparée pour éviter les conflits avec la branche principale:

git checkout -b feature/your-branch-name

---

4. faire des changements

Maintenant que vous êtes dans votre succursale, apportez les modifications nécessaires au code, à la documentation ou à d'autres parties du projet. Assurez-vous de tout tester avant de passer à l'étape suivante.

---

5. Commettre des changements

Une fois vos modifications terminées, il est temps de les commettre. Suivez ces étapes:

1. Ajouter les modifications à la zone de mise en scène:

git add .

2. Commettre les modifications avec un message clair et descriptif:

git commit -m " Your descriptive message here "

3. Assurez-vous que votre message de validation explique clairement les modifications que vous avez apportées.

6. Pousser les changements

Après avoir commis vos modifications localement, poussez la branche vers votre référentiel GitHub.

git push origin feature/your-branch-name

Cela téléchargera votre branche dans votre référentiel fourchu sur GitHub.

7. Créer une demande de traction

Avec vos modifications poussées vers GitHub, vous êtes prêt à soumettre une demande de traction (PR) afin que les responsables puissent consulter votre travail.

• Accédez à votre référentiel fourchu sur GitHub.
  
• Cliquez sur le bouton "Comparez et tirez la demande".
  
• Fournissez un titre et une description détaillée de vos modifications.
  
• Soumettez la demande de traction.
  
• Après avoir examiné, les mainteneurs fusionneront votre RP ou fourniront des commentaires pour les révisions.
  

8. Synchronisation de votre fourchette

Si le référentiel d'origine est mis à jour pendant que vous travaillez, vous voudrez peut-être synchroniser votre fourche pour le garder à jour. Voici comment:

1. Ajoutez le référentiel en amont comme télécommande:

git remote add upstream https://github.com/original-owner/repository-name.git

2. Répondez les derniers changements du référentiel en amont:

git fetch upstream

3. Fusionner les changements en amont dans votre branche principale locale:

git checkout main
git merge upstream/main

4. Poussez la branche principale mise à jour vers votre fourche:

git push origin main

9. Conseils pour écrire de bons messages de validation

• Gardez-le concis: visez un message de validation moins de 50 caractères.
  
• Utilisez l'humeur impérative: par exemple, écrivez "Correction de bug" au lieu de "Correction d'un bug".
  
• Fournir un contexte: inclure le numéro de problème ou décrire l'objectif du changement.
  Exemple: Correction # 42 - Résoudre le bug dans l'authentification de l'utilisateur.