good first issues

Bons premiers problèmes

Trouvez de bons premiers problèmes directement de votre CLI!

Installer de bons premiers problèmes

Nécessite Python 3.6.1 ou plus.

$ pip3 install good-first-issues --upgrade

La CLI utilise l'alias gfi pour exécuter les commandes.

Contenu

• Installer de bons premiers problèmes
• Contenu
  • Créer un jeton d'accès personnel GitHub
• Usage
  • Rechercher des problèmes
    • Interrogez tous les références dans une organisation
    • Interroger un seul dépôt dans une organisation
    • Interroger tous les repos dans un profil utilisateur
    • Interrogez un seul dépôt dans un profil utilisateur.
  • Rechercher des problèmes approuvés par hacktoberfest
    • Interrogez tous les dépositions avec le thème hacktoberfest
    • Interrogez tous les référentiels avec le sujet «Hacktoberfest» dans une organisation ou dans un profil utilisateur
  • Modification des limites de sortie
  • Affichage des problèmes sur le navigateur
• Contributif

Créer un jeton d'accès personnel GitHub

La CLI nécessite un jeton d'accès personnel GitHub pour faire des demandes à l'API GitHub.

Obtenez un jeton d'accès personnel à grain fin gitub

Vous pouvez ajouter une description à votre jeton, sélectionner "Référentiels publics (en lecture seule)" et sélectionnez Générer le jeton .

Fournir un jeton à CLI:

$ gfi config

Le jeton est stocké localement sur /home/<username>/.gfi/good-first-issues < username>/.gfi/good-first-issues.

Token dans la variable de l'évaluon:

Conservez le jeton avec le nom de GFITOKEN dans votre environnement.

Usage

GitHub fournit une API pour récupérer les données des utilisateurs et de l'organisation. Le jeton d'accès personnel est requis pour l'authentification et la récupération des données.

Rechercher des problèmes

Pour rechercher des problèmes, utilisez la commande gfi search .

Interrogez tous les références dans une organisation

$ gfi search " rust-lang "

Démo

Interroger un seul dépôt dans une organisation

$ gfi search " facebook " --repo " jest "

Démo

Interroger tous les repos dans un profil utilisateur

$ gfi search " yankeexe " --user

Démo

Interrogez un seul dépôt dans un profil utilisateur.

--user Indicateur d'utilisation non requis ici.

$ gfi search " yankeexe " --repo " good-first-issues "

Démo

Rechercher des problèmes approuvés par hacktoberfest

Interrogez tous les dépositions avec le thème hacktoberfest

$ gfi search --hacktoberfest

$ gfi search -hf

Démo

Interrogez tous les référentiels avec le sujet «Hacktoberfest» dans une organisation ou dans un profil utilisateur

Interrogez tous les référentiels avec le sujet «Hacktoberfest» dans une organisation.

$ gfi search " facebook " --hacktoberfest

Démo

Interrogez tous les référentiels avec la rubrique «Hacktoberfest» dans un profil utilisateur. --user Indicateur d'utilisation non requis ici.

$ gfi search " yankeexe " --hacktoberfest

Démo

Modification des limites de sortie

La sortie est limitée pour afficher 10 problèmes par défaut. Utiliser --limit Indicateur pour définir le nombre de problèmes pour la sortie ou --all pour aucune limite.

Limitez les problèmes à 12

$ gfi search " facebook " --limit 12

Démo

Voir tous les problèmes trouvés.

$ gfi search " rust-lang " --all

Affichage des problèmes sur le navigateur

Il est difficile de naviguer à travers tous les problèmes lorsque vous avez l'indicateur --all activé, vous pouvez afficher facilement les problèmes de votre navigateur en utilisant l'indicateur --web .

$ gfi search " facebook " --all --web

Démo

Contributif

Pour obtenir des conseils sur la mise en place d'un environnement de développement et comment apporter une contribution aux good-first-issues , consultez les directives contributives.