GitHub pour les débutants : débuter avec les contributions OSS

Bienvenue sur GitHub pour les débutants. Jusqu’à présent, nous avons discuté des problèmes et projets GitHub, Actions GitHub, sécurité, Pages GitHub et Markdown. Cette fois, nous allons parler des logiciels open source et de la manière de contribuer à cette communauté. À la fin de cet article, vous saurez ce qu’est l’open source, comment trouver des projets sur lesquels travailler, comment lire un référentiel open source et commencerez à apporter vos premières contributions. Alors commençons !

Comme toujours, si vous préférez regarder la vidéo ou si vous souhaitez y faire référence, nous avons tous nos épisodes GitHub pour débutants disponibles sur YouTube.

Qu’est-ce que l’open source ?

Les logiciels open source (OSS) font référence à des logiciels comportant du code source disponible gratuitement. Contrairement aux « logiciels fermés », les logiciels libres sont accessibles au public et peuvent être utilisés et exploités par tous. Cela signifie que tout le travail, y compris la base de code et la communication entre les utilisateurs, est accessible à tous.

Si vous débutez dans le monde du développement de logiciels, parcourir et contribuer à des projets open source est un excellent moyen de vous plonger dans des projets de grande envergure et à fort impact utilisés par d’innombrables utilisateurs dans le monde entier.

GitHub est la référence en matière de logiciels open source. Voyons donc comment trouver des projets auxquels vous pouvez contribuer.

Comment trouver des projets OSS sur lesquels travailler

Contribuer à un projet de logiciel open source pour la première fois peut être intimidant : nous sommes tous passés par là ! La première étape consiste à rechercher des projets dans une langue que vous connaissez et qui acceptent de nouveaux contributeurs. L’une des façons de procéder est de demander de l’aide à GitHub Copilot Chat.

• Accédez à github.com et sélectionnez l’icône Copilot pour ouvrir une fenêtre de discussion.
• Dans le coin inférieur gauche de la fenêtre de discussion, utilisez la zone de liste déroulante pour sélectionner Demander.
• Saisissez une invite comme celle-ci, mais n’oubliez pas de la mettre à jour pour une langue avec laquelle vous êtes à l’aise.

Je recherche une liste de projets open source écrits en TypeScript qui acceptent de nouveaux contributeurs. Recherchez sur GitHub et réduisez la liste aux référentiels qui utilisent le label bon premier numéro et qui ont plus de 100 étoiles sur GitHub. 

Copilot effectuera quelques recherches et renverra une liste de projets que vous pourrez explorer, filtrés par le label bon premier numéro. Ce label indique qu’un numéro est adapté aux débutants et constitue un excellent point de départ pour les nouveaux contributeurs. Ce label est un excellent moyen de trouver des problèmes dans un projet sur lequel vous pouvez travailler.

Par exemple, disons que vous souhaitez contribuer au référentiel vscode.

1. Accédez au dépôt vscode.
2. En haut du dépôt, sélectionnez l’onglet Problèmes.
3. Sur la page Problèmes, cliquez sur la case Libellés pour ouvrir le menu déroulant.
4. Dans la zone de texte du menu déroulant, commencez à saisir « bon » jusqu’à ce que l’option bon premier numéro s’affiche.
5. Sélectionnez le libellé bon premier numéro.

La fenêtre se mettra à jour et affichera une liste des premiers problèmes sur lesquels vous pourrez travailler. Mais avant de vous lancer, vous devriez lire le guide du contributeur dans le référentiel du projet. La plupart des projets open source bien entretenus en auront un.

Comprendre un projet open source

Comme nous venons de le mentionner, la plupart des projets open source ont quelques points communs s’ils sont bien entretenus. Il s’agit des éléments suivants :

• Un fichier README bien documenté avec les instructions d’installation.
• Un guide du contributeur qui explique comment contribuer.
• Une licence Open Source, pour que tout le monde sache que le projet est gratuit.
• Au moins 100 étoiles GitHub pour montrer qu’il est utilisé dans la communauté.
• Développement actif afin que vous sachiez qu’un responsable du code source pourra examiner vos contributions.
• Un label bon premier numéro pour indiquer qu’il est ouvert à de nouveaux contributeurs.

Lorsque vous recherchez un projet auquel contribuer, voici les éléments que vous devriez rechercher dans un référentiel.

💡 Pour plus de documentation sur la recherche d’un bon projet open source, accédez à gh.io/gfb-oss pour en savoir plus sur la recherche de bons premiers problèmes.

Faire une contribution OSS

Regardons maintenant un projet réel et réfléchissons à la manière dont vous soumettriez votre premier numéro. Pour cette démo, jetez un œil au le dépôt gitfolio. En utilisant les puces ci-dessus, nous voulons voir si ce serait un bon projet sur lequel travailler.

• Le projet dispose d’un fichier README bien documenté.
• Le projet dispose d’un guide du contributeur : CONTRIBUTING.md.
• Vous pouvez voir la licence open source : LICENSE.
• Il compte plusieurs milliers d’étoiles, soit bien au-delà de notre référence de 100.
• En haut de la liste des fichiers, vous pouvez voir l’archivage le plus récent qui devrait être assez récent. Au moment d’écrire ces lignes, le dernier enregistrement a eu lieu hier, ce qui indique que le projet est activement maintenu.

Sur la base de ces points, tant que vous êtes familier avec TypeScript, il s’agit d’un bon référentiel auquel contribuer. Cependant, vous n’avez pas besoin d’être familier avec TypeScript pour continuer à suivre la démo.

Vous souhaitez maintenant créer un fork du référentiel. Un fork est une copie du référentiel sur laquelle nous pouvons librement expérimenter et apporter des modifications sans affecter le projet d’origine. Nous utilisons généralement des forks pour les contributions open source. Si vous avez besoin d’un rappel sur la création d’un référentiel, consultez ce ancien blog GitHub pour débutants.

1. Accédez à la page d’accueil du projet si vous n’y êtes pas déjà.
2. En haut du projet, cliquez sur le bouton Fork.
3. Dans la nouvelle fenêtre, laissez-vous comme propriétaire et assurez-vous que le « Nom du référentiel » est le même que celui du référentiel d’origine (c’est-à-dire « gitfolio »).
4. En bas de la fenêtre, sélectionnez Créer un fork.
5. Dans votre copie forkée du référentiel, cliquez sur README.md dans la liste des fichiers.
6. Modifiez le fichier en ajoutant du texte.
7. En haut à droite, sélectionnez Valider les modifications…
8. Assurez-vous de sélectionner l’option en bas pour Créer une nouvelle branche à partir de ce commit et lancez une pull request.
9. Sélectionnez Proposer des modifications.
10. Dans la fenêtre suivante, cliquez sur le bouton Créer une demande d’extraction. Cela vous permettra de créer une pull request vers le référentiel principal depuis votre branche avec les modifications.
11. En haut de la fenêtre “Ouvrir une demande d’extraction”, sélectionnez comparer entre les forks. Cela montrera les modifications de votre fork par rapport au référentiel d’origine.
12. Si vous soumettez une modification réelle au référentiel (pas seulement en parcourant une démo), c’est ici que vous donnerez un titre et une description à votre pull request. Vous souhaiterez également fournir un lien vers le problème que vous résolviez dans la description de la demande d’extraction.

À ce stade, vous seriez prêt à soumettre votre pull request en cliquant sur le bouton en bas de la fenêtre. Cependant, une fois que vous faites cela, cela ne devient plus simplement un changement dans votre fork et sera une mise à jour demandée sur le référentiel d’origine. C’est pourquoi cela n’est pas inclus dans les étapes ci-dessus. Lorsque vous soumettez votre demande d’extraction, elle sera disponible et prête à être examinée et, espérons-le, approuvée par un responsable !

Une fois approuvé et fusionné, GitHub applique automatiquement les modifications de votre fork dans la branche principale du référentiel d’origine, la source officielle de vérité pour la base de code.

Quelle est la prochaine étape ?

Félicitations ! Vous avez appris à apporter vos propres contributions aux logiciels open source. J’espère que cela vous inspirera à contribuer à vos projets préférés.

Et si vous recherchez plus d’informations, nous disposons de nombreuses documentations qui peuvent vous aider. Voici quelques liens pour vous faire connaître :

• Trouver des moyens de contribuer à l’open source sur GitHub
• Contribuer à des projets open source
• Contribuer à un projet via le forking

Bon codage !

L’article GitHub pour les débutants : Démarrer avec les contributions OSS est apparu en premier sur Le blog GitHub.

Aller à la source d’origine