good first issues

Gute erste Ausgaben

Finden Sie gute erste Ausgaben direkt aus Ihrer CLI!

Installieren Sie gute erste Ausgaben

Benötigt Python 3.6.1 oder höher.

$ pip3 install good-first-issues --upgrade

Die CLI verwendet den Alias gfi , um Befehle auszuführen.

Inhalt

• Installieren Sie gute erste Ausgaben
• Inhalt
  • Erstellen Sie GitHub Personal Access Token
• Verwendung
  • Suche nach Problemen
    • Fragen Sie alle Repos in einer Organisation ab
    • Fragen Sie ein einzelnes Repo in einer Organisation ab
    • Fragen Sie alle Repos in einem Benutzerprofil ab
    • Fragen Sie ein einzelnes Repo in einem Benutzerprofil ab.
  • Suchen Sie nach Hacktoberfest genehmigten Themen
    • Fragen Sie alle Repos mit dem Thema hacktoberfest
    • Fragen Sie alle Repos mit dem Thema "Hacktoberfest" in einer Organisation oder in einem Benutzerprofil ab
  • Ausgangsgrenzen ändern
  • Probleme im Browser anzeigen
• Beitragen

Erstellen Sie GitHub Personal Access Token

Die CLI erfordert, dass GitHub Personal Access Token an der Github -API Anfragen stellt.

Holen Sie sich GitHub Fine-Körnern persönlicher Zugangsantrieb

Sie können Ihrem Token eine Beschreibung hinzufügen, "öffentliche Repositories (schreibgeschützt)" auswählen und Token generieren .

Geben Sie die CLI -Token zur Verfügung:

$ gfi config

Token wird lokal auf /home/<username>/.gfi/good-first-issues isues Datei gespeichert.

Token in der Umgebung Variable:

Bewahren Sie das Token mit dem Namen GFITOKEN in Ihrer Umgebung auf.

Verwendung

GitHub bietet API zum Abrufen von Benutzer- und Organisationsdaten. Personal Access Token ist für die Authentifizierung und das Abheben von Daten erforderlich.

Suche nach Problemen

Um nach Problemen zu suchen, verwenden Sie den gfi search .

Fragen Sie alle Repos in einer Organisation ab

$ gfi search " rust-lang "

Demo

Fragen Sie ein einzelnes Repo in einer Organisation ab

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

Demo

Fragen Sie alle Repos in einem Benutzerprofil ab

$ gfi search " yankeexe " --user

Demo

Fragen Sie ein einzelnes Repo in einem Benutzerprofil ab.

--user hier nicht erforderlich.

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

Demo

Suchen Sie nach Hacktoberfest genehmigten Themen

Fragen Sie alle Repos mit dem Thema hacktoberfest

$ gfi search --hacktoberfest

$ gfi search -hf

Demo

Fragen Sie alle Repos mit dem Thema "Hacktoberfest" in einer Organisation oder in einem Benutzerprofil ab

Fragen Sie alle Repos mit dem Thema "Hacktoberfest" in einer Organisation ab.

$ gfi search " facebook " --hacktoberfest

Demo

Fragen Sie alle Repos mit dem Thema "Hacktoberfest" in einem Benutzerprofil ab. --user hier nicht erforderlich.

$ gfi search " yankeexe " --hacktoberfest

Demo

Ausgangsgrenzen ändern

Die Ausgabe ist beschränkt auf die standardmäßige Anzeige von 10 Problemen. Verwenden Sie --limit -Flag, um die Anzahl der Probleme für die Ausgabe oder --all ohne Grenzen zu setzen.

Beschränken Sie die Probleme auf 12

$ gfi search " facebook " --limit 12

Demo

Alle Fragen anzeigen.

$ gfi search " rust-lang " --all

Probleme im Browser anzeigen

Es ist schwierig, alle Probleme zu navigieren, wenn Sie das --all -Flag aktiviert haben. Sie können die Probleme in Ihrem Browser mit dem Flag --web -Flag problemlos anzeigen.

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

Demo

Beitragen

Anleitungen zum Aufbau einer Entwicklungsumgebung und zum Beitrag zu einem Beitrag zu good-first-issues finden Sie in den beitragenden Richtlinien.