good first issues

Buenos primeros problemas

¡Encuentra buenos primeros problemas directamente de tu CLI!

Instalar buenos primeros problemas

Requiere Python 3.6.1 o superior.

$ pip3 install good-first-issues --upgrade

La CLI usa el alias gfi para ejecutar comandos.

Contenido

• Instalar buenos primeros problemas
• Contenido
  • Crear token de acceso personal GitHub
• Uso
  • Buscar problemas
    • Consulta todos los reposos en una organización
    • Consulta un solo repositorio en una organización
    • Consulta todos los reposos en un perfil de usuario
    • Consulte un solo repositorio en un perfil de usuario.
  • Buscar problemas aprobados por Hacktoberfest
    • Consulta todos los reposos con Topic hacktoberfest
    • Consulte todos los reposos con el tema 'Hacktoberfest' en una organización o en un perfil de usuario
  • Cambiar los límites de salida
  • Viendo problemas en el navegador
• Que contribuye

Crear token de acceso personal GitHub

La CLI requiere Token de acceso personal GitHub para hacer solicitudes a la API de GitHub.

Obtenga token de acceso personal de grano fino GitHub

Puede agregar una descripción a su token, seleccionar "Repositorios públicos (solo lectura)" y seleccionar Generar token .

Proporcionar ficha a la CLI:

$ gfi config

El token se almacena localmente en el archivo /home/<username>/.gfi/good-first-issues <USername>/.gfi/good-first-issues.

Variable de envío de token:

Guarde el token con el nombre de GFITOKEN en su entorno.

Uso

GitHub proporciona API para obtener datos de usuario y organización. Se requiere un token de acceso personal para la autenticación y la obtención de datos.

Buscar problemas

Para buscar problemas, use el comando gfi search .

Consulta todos los reposos en una organización

$ gfi search " rust-lang "

Manifestación

Consulta un solo repositorio en una organización

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

Manifestación

Consulta todos los reposos en un perfil de usuario

$ gfi search " yankeexe " --user

Manifestación

Consulte un solo repositorio en un perfil de usuario.

-Bandera --user no se requiere aquí.

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

Manifestación

Buscar problemas aprobados por Hacktoberfest

Consulta todos los reposos con Topic hacktoberfest

$ gfi search --hacktoberfest

$ gfi search -hf

Manifestación

Consulte todos los reposos con el tema 'Hacktoberfest' en una organización o en un perfil de usuario

Consulte todos los reposos con el tema 'Hacktoberfest' en una organización.

$ gfi search " facebook " --hacktoberfest

Manifestación

Consulte todos los reposos con el tema 'Hacktoberfest' en un perfil de usuario. -Bandera --user no se requiere aquí.

$ gfi search " yankeexe " --hacktoberfest

Manifestación

Cambiar los límites de salida

La salida está limitada para mostrar 10 problemas de forma predeterminada. Use el indicador --limit para establecer el número de problemas para la salida o, --all sin límites.

Limite los problemas a 12

$ gfi search " facebook " --limit 12

Manifestación

Ver todos los problemas encontrados.

$ gfi search " rust-lang " --all

Viendo problemas en el navegador

Es difícil navegar a través de todos los problemas cuando tiene el indicador --all habilitado, puede ver los problemas en su navegador con facilidad usando el indicador --web .

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

Manifestación

Que contribuye

Para obtener orientación sobre la creación de un entorno de desarrollo y cómo hacer una contribución a good-first-issues , consulte las pautas contribuyentes.