Rendre le dépôt visible
Gardez le dépôt public, actif et facile à évaluer depuis GitHub sans contexte privé.
Pour les mainteneurs
Pour les mainteneurs
Aidez Good First Issue à découvrir, évaluer et garder utile le travail adapté aux nouveaux contributeurs dans votre dépôt.
Découverte
Faire indexer votre dépôt
Good First Issue indexe actuellement les dépôts GitHub publics et les issues GitHub ouvertes. Les mainteneurs peuvent soumettre un dépôt public après connexion, puis le crawler d'issues le traitera une fois l'enregistrement créé.
Documenter les bases du projet
Gardez le README, le guide CONTRIBUTING, la licence, la configuration locale et les instructions de test assez clairs pour un nouveau contributeur.
Soumettre le dépôt
Soumettez le dépôt public après connexion. Une fois l'enregistrement créé, le crawler continuera à traiter les issues ouvertes.
Labels d'issue
Marquer les issues adaptées aux débutants
La tâche de récupération actuelle recherche des issues GitHub ouvertes avec les labels good first issue et help wanted. Ces labels rendent votre travail plus facile à découvrir, mais l'issue doit encore contenir assez de contexte pour qu'un premier contributeur agisse sans risque.
Inclure assez de contexte pour rendre la première pull request reviewable
- Le contexte expliquant pourquoi l'issue compte.
- Le résultat attendu en termes concrets.
- Les fichiers, packages ou zones produit à inspecter d'abord.
- Les commandes de test ou étapes de vérification manuelle.
- Si les contributeurs doivent confirmer le périmètre avant de coder.
Recommandations
Améliorer la qualité des recommandations
Les recommandations fonctionnent mieux quand le dépôt montre une maintenance active et que l'issue est assez petite pour qu'un nouveau contributeur la termine sans deviner la direction du projet.
Maintenance récente
Des commits, réponses et activités de tri récents aident les contributeurs à croire qu'une review est encore possible.
Rédaction claire
Les issues avec contexte, critères d'acceptation et notes de configuration sont plus faciles à associer à de nouveaux contributeurs.
Petit périmètre reviewable
Documentation, tests, polissage d'interface et petites corrections de bugs sont plus faciles à recommander que de grands travaux de design.
Boucle contributeur saine
Des tests exécutables et des retours réactifs réduisent les pull requests abandonnées et gardent les recommandations utiles.
Éviter les issues qui semblent accessibles mais sont difficiles à finir
- Issues anciennes qu'aucun mainteneur n'a confirmées récemment.
- Grandes fonctionnalités avec responsabilité ou direction produit floues.
- Tâches nécessitant du contexte privé, des identifiants ou un accès release.
- Issues sans notes de reproduction, consignes de configuration ou comportement attendu.
Prêt à ajouter un dépôt ?
Soumettez un dépôt GitHub public depuis cette page, puis utilisez les issues indexées et les canaux de retour pour vérifier comment votre travail adapté aux débutants apparaît.