good first issues

良い最初の問題

あなたのCLIから良い最初の問題を見つけてください！

良い最初の問題をインストールします

Python 3.6.1以降が必要です。

$ pip3 install good-first-issues --upgrade

CLIはエイリアスgfiを使用してコマンドを実行します。

コンテンツ

• 良い最初の問題をインストールします
• コンテンツ
  • GitHubパーソナルアクセストークンを作成します
• 使用法
  • 問題を検索します
    • 組織内のすべてのリポジトリをクエリします
    • 組織内の単一のリポジトリをクエリします
    • ユーザープロファイルですべてのリポジトリをクエリします
    • ユーザープロファイルで単一のリポジトリをクエリします。
  • HacktoberFestが承認した問題を検索します
    • トピックhacktoberfestですべてのレポをクエリします
    • 組織またはユーザープロファイルのトピック「hacktoberfest」ですべてのリポジをクエリします
  • 出力制限の変更
  • ブラウザで問題の表示
• 貢献

GitHubパーソナルアクセストークンを作成します

CLIは、GitHub APIにリクエストを行うためにGitHubの個人アクセストークンを必要とします。

Githubを入手してください

トークンに説明を追加し、「パブリックリポジトリ（読み取り専用）」を選択し、 [生成]トークンを選択できます。

CLIにトークンを提供します：

$ gfi config

トークンは/home/<username>/.gfi/good-first-issues <username>/.gfi/good-first-issuesファイルにローカルに保存されます。

環境変数のトークン：

環境にGFITOKENという名前のトークンを保管してください。

使用法

GitHubは、ユーザーと組織のデータを取得するためのAPIを提供します。個人アクセストークンは、認証とデータフェッチに必要です。

問題を検索します

問題を探すには、 gfi searchコマンドを使用します。

組織内のすべてのリポジトリをクエリします

$ gfi search " rust-lang "

デモ

組織内の単一のリポジトリをクエリします

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

デモ

ユーザープロファイルですべてのリポジトリをクエリします

$ gfi search " yankeexe " --user

デモ

ユーザープロファイルで単一のリポジトリをクエリします。

--userここではユーザーフラグは必要ありません。

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

デモ

HacktoberFestが承認した問題を検索します

トピックhacktoberfestですべてのレポをクエリします

$ gfi search --hacktoberfest

$ gfi search -hf

デモ

組織またはユーザープロファイルのトピック「hacktoberfest」ですべてのリポジをクエリします

組織内のトピック「HacktoberFest」ですべてのレポをクエリします。

$ gfi search " facebook " --hacktoberfest

デモ

ユーザープロファイルのトピック「HacktoberFest」ですべてのリポジトリをクエリします。 --userここではユーザーフラグは必要ありません。

$ gfi search " yankeexe " --hacktoberfest

デモ

出力制限の変更

出力は、デフォルトで10の問題を表示することに制限されています。 --limitフラグを使用して、出力の問題の数を設定するか、制限なしで--all設定します。

問題を12に制限します

$ gfi search " facebook " --limit 12

デモ

見つかったすべての問題を表示します。

$ gfi search " rust-lang " --all

ブラウザで問題の表示

--allフラグを使用してブラウザの問題--web簡単に表示することができます。

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

デモ

貢献

開発環境のセットアップと、 good-first-issuesに貢献する方法に関するガイダンスについては、貢献ガイドラインを参照してください。