Accueillir! ??
Good First Issue est une initiative visant à sélectionner des projets faciles à sélectionner parmi des projets populaires, afin que les développeurs qui n'ont jamais contribué à l'open source puissent se lancer rapidement.
Les responsables de l'open source cherchent toujours à impliquer davantage de personnes, mais les nouveaux développeurs pensent généralement qu'il est difficile de devenir contributeur. Nous pensons qu'amener les développeurs à résoudre les problèmes très facilement supprime les obstacles aux contributions futures. C'est pourquoi Good First Issue existe.
Vous êtes invités à ajouter un nouveau projet dans Good First Issue, et nous encourageons tous les projets – anciens et nouveaux, grands et petits.
Suivez ces étapes simples :
Notre objectif est de sélectionner des projets pour de nouveaux contributeurs open source. Pour maintenir la qualité des projets dans Good First Issue, veuillez vous assurer que votre référentiel GitHub répond aux critères suivants :
Il présente au moins trois numéros avec le label good first issue
. Ce label est déjà présent sur tous les référentiels par défaut. Sinon, vous pouvez suivre les étapes ici.
Il compte au moins 10 contributeurs.
Il contient un README.md avec des instructions de configuration détaillées pour le projet et un CONTRIBUTING.md avec des directives pour les nouveaux contributeurs.
Il est activement entretenu.
Ajoutez le chemin de votre référentiel (par ordre lexicographique) dans data/repositories.toml.
Créez une nouvelle pull-request. Veuillez ajouter le lien vers la page des problèmes du référentiel dans la description du PR. Une fois la pull request fusionnée, les modifications seront actives sur goodfirstissue.dev.
Good First Issue comporte deux composants : l'application frontale construite avec Nuxt.js et un script de remplissage de données écrit en Python.
Pour apporter de nouvelles fonctionnalités et modifications au site Web, vous souhaiterez exécuter l'application localement. Veuillez suivre ces étapes :
Clonez le projet localement. Assurez-vous que Python 3 et une version récente de Node.js sont installés sur votre ordinateur.
Faites une copie des exemples de fichiers de données pour que votre application locale puisse les utiliser et renommez-les avec le nom de fichier attendu par l'application. Cette étape est importante, car l'application frontale ne fonctionnera pas sans ces fichiers de données.
$ cp data/generated.sample.json data/generated.json $ cp données/tags.sample.json données/tags.json
Créez l'application frontale et démarrez le serveur de développement.
$ bun install # installer les dépendances$ bun dev # démarrer le serveur de développement
L'application devrait s'ouvrir dans votre navigateur.