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 .

Токен в переменной контроции:

Храните жетон с названием 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

Демо

Изменение пределов вывода

Вывод ограничен по умолчанию. Используйте --limit Flag, чтобы установить количество проблем для вывода или --all без ограничений.

Ограничьте проблемы 12

$ gfi search " facebook " --limit 12

Демо

Просмотреть все найденные проблемы.

$ gfi search " rust-lang " --all

Просмотр проблем в браузере

Трудно перемещаться по всем вопросам, когда у вас включен --all флаг, вы можете с легкостью просмотреть проблемы в браузере, используя флаг --web .

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

Демо

Внося

Для настройки среды разработки и о том, как внести свой вклад в good-first-issues , см. В соответствии с руководящими принципами.