Rejoignez la tendance du codage social et contribuez aux référentiels GitHub

Avez-vous déjà trouvé un package sur GitHub que vous avez apprécié, mais que vous vouliez ajouter une fonctionnalité rapide, corriger un bogue que vous avez trouvé ou peut-être simplement contribuer à l'open source dans son ensemble? Rejoignez la tendance du codage social, partagez vos compétences et aidez à profiter du monde open source. Dans cet article, découvrez comment contribuer au code d'un référentiel sur GitHub ou sur tout service git hébergé.

Obtenir la configuration

Cet article suppose que vous avez déjà un compte GitHub, mais sinon, veuillez vous inscrire rapidement pour un compte gratuit . Assurez-vous également que git est déjà installé en exécutant la commande suivante dans le terminal:

 git --version

Si au lieu de voir le numéro de version, vous obtenez un message "commande introuvable", vous pouvez installer git avec la commande:

 sudo apt-get -y install git

Fork le référentiel

Vous devez d'abord choisir le référentiel auquel vous souhaitez contribuer et le visiter dans votre navigateur Web. Si vous ne savez pas quel référentiel choisir, vous pouvez utiliser le référentiel de démonstration situé à l' adresse https://github.com/mdizak/muo_demo . Ceci est une démonstration simple, et vous êtes invités à créer des pull requests à des fins de test et d'apprentissage.

Lors de l'affichage du référentiel dans votre navigateur Web, recherchez le bouton Référentiel Fork et cliquez dessus. Cela créera le dépôt vers votre propre compte GitHub et vous y amènera. Ensuite, vous devez cloner le référentiel nouvellement forké , alors ouvrez le terminal sur votre ordinateur local et exécutez:

 git clone https://github.com/myusername/muo_demo.git
 cd muo_demo

Naturellement, assurez-vous de remplacer l'URL ci-dessus par celle de votre référentiel nouvellement fourchu. Une fois cloné, ajoutez le référentiel d'origine en amont avec la commande:

 git remote add upstream https://github.com/mdizak/muo_demo.git

Assurez-vous de changer l'URL dans la commande ci-dessus avec celle du référentiel d'origine que vous avez cloné. Cela signifie que c'est un référentiel parent à partir duquel vous travaillez.

Préparer le référentiel local

Chaque fois avant de commencer à travailler sur une nouvelle contribution, assurez-vous que vous exécutez la dernière base de code du référentiel parent. Dans le répertoire du projet, exécutez les commandes suivantes dans le terminal:

 git checkout master
 git pull upstream master && git push origin master

La première commande garantit que vous travaillez actuellement dans la branche principale et la deuxième commande synchronise le référentiel parent avec vos référentiels locaux et GitHub. Cela garantit que vous modifiez la base de code la plus à jour et que vous ne travaillez pas avec du code obsolète.

Assurez-vous également de vérifier si le projet a un fichier contrib.md, et si c'est le cas, assurez-vous de suivre ce qu'il dit. Parfois, les projets ont des directives spécifiques sur la manière de fournir des contributions, qui doivent toujours être suivies.

Créer une nouvelle branche

Vous devez créer une nouvelle branche qui contiendra toutes les modifications pour cette contribution, qui sera ultérieurement fusionnée dans le référentiel GitHub principal par les responsables du projet. La branche doit être alphanumérique et peut être nommée comme vous le souhaitez.

Bien que cela ne soit pas obligatoire, il est généralement considéré comme une courtoisie courante de préfixer le nom de la branche avec un correctif / pour des corrections de bogues rapides ou une fonctionnalité / pour des fonctionnalités supplémentaires. Choisissez le nom de votre branche et exécutez la commande:

 git checkout -b feature/my_cool_feature

Vous devez toujours créer une branche distincte pour chaque fonctionnalité / correction de bogue et ne jamais inclure plusieurs contributions dans une seule. Cela permet de maintenir un flux de développement fluide et de garantir que votre contribution est acceptée et incluse dans le projet.

Maintenant que votre branche a été créée, continuez et apportez toutes les modifications nécessaires que vous souhaitez avec le flux de travail standard de git.

Valider et créer une demande d'extraction

Une fois que vous avez terminé le travail sur votre contribution, validez-la avec un message de validation approprié et poussez-la vers votre référentiel forké avec les commandes:

 git commit --file commit.txt
 git push -u origin feature/my_cool_feature

La dernière étape consiste à créer une pull request alertant les responsables du projet qu'une nouvelle contribution est en attente. Visitez le référentiel GitHub fourchu dans votre navigateur Web et vous verrez un bouton déroulant vous permettant de changer de branche. Passez à votre branche nouvellement créée et la page suivante contiendra un lien vous permettant de créer une nouvelle pull request.

En cliquant sur ce lien, vous verrez une page qui affiche votre message de validation et toutes les modifications que vous avez apportées au code. Vérifiez tout pour vous assurer qu'il est correct, ajoutez tout message supplémentaire nécessaire pour les responsables et soumettez la demande d'extraction.

Continuer à contribuer à GitHub

Félicitations, vous avez soumis avec succès une contribution à un projet GitHub!

Votre pull request est maintenant en attente d'examen et d'approbation par les responsables du projet, et vous serez informé par e-mail si elle a été approuvée ou non, et avec tous les messages qu'ils ont pour vous. Maintenant que vous avez appris à contribuer à des projets sur GitHub, continuez à avancer et contribuez à développer la communauté open source .