good first issues

Boas primeiras questões

Encontre bons primeiros problemas diretamente da sua CLI!

Instale bons primeiros problemas

Requer Python 3.6.1 ou superior.

$ pip3 install good-first-issues --upgrade

A CLI usa o Alias gfi para executar comandos.

Conteúdo

• Instale bons primeiros problemas
• Conteúdo
  • Crie token de acesso pessoal do GitHub
• Uso
  • Procure problemas
    • Consulte todos os repositórios em uma organização
    • Consulte um único repositório em uma organização
    • Consulte todos os repositórios em um perfil de usuário
    • Consulte um único repositório em um perfil de usuário.
  • Pesquise problemas aprovados pela Hacktoberfest
    • Consulte todos os repositórios com tópico hacktoberfest
    • Consulte todos os repositórios com tópico 'hacktoberfest' em uma organização ou em um perfil de usuário
  • Alteração dos limites de saída
  • Visualizando problemas no navegador
• Contribuindo

Crie token de acesso pessoal do GitHub

A CLI exige o token de acesso pessoal do GitHub para fazer solicitações à API do GitHub.

Obtenha token de acesso pessoal de granulação fina do GitHub

Você pode adicionar uma descrição ao seu token, selecionar "Repositórios públicos (somente leitura)" e selecionar o token gerar .

Forneça token para a CLI:

$ gfi config

O token é armazenado localmente em /home/<username>/.gfi/good-first-issues <username>/.gfi/good-first-itsues.

Token in Envraionment Variable:

Armazene o token com o nome GFITOKEN em seu ambiente.

Uso

O GitHub fornece API para buscar dados de usuários e organizações. O token de acesso pessoal é necessário para autenticação e busca de dados.

Procure problemas

Para procurar problemas, use o comando gfi search .

Consulte todos os repositórios em uma organização

$ gfi search " rust-lang "

Demonstração

Consulte um único repositório em uma organização

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

Demonstração

Consulte todos os repositórios em um perfil de usuário

$ gfi search " yankeexe " --user

Demonstração

Consulte um único repositório em um perfil de usuário.

-Sinalizador --user não é necessário aqui.

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

Demonstração

Pesquise problemas aprovados pela Hacktoberfest

Consulte todos os repositórios com tópico hacktoberfest

$ gfi search --hacktoberfest

$ gfi search -hf

Demonstração

Consulte todos os repositórios com tópico 'hacktoberfest' em uma organização ou em um perfil de usuário

Consulte todos os repositórios com o tópico 'hacktoberfest' em uma organização.

$ gfi search " facebook " --hacktoberfest

Demonstração

Consulte todos os repositórios com tópico 'hacktoberfest' em um perfil de usuário. -Sinalizador --user não é necessário aqui.

$ gfi search " yankeexe " --hacktoberfest

Demonstração

Alteração dos limites de saída

A saída é limitada a exibir 10 problemas por padrão. Use o sinalizador --limit para definir o número de problemas para saída ou --all sem limites.

Limitar os problemas a 12

$ gfi search " facebook " --limit 12

Demonstração

Ver todos os problemas encontrados.

$ gfi search " rust-lang " --all

Visualizando problemas no navegador

É difícil navegar por todos os problemas quando você tiver o sinalizador --all ativados, pode visualizar os problemas no seu navegador com facilidade usando o sinalizador --web .

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

Demonstração

Contribuindo

Para obter orientações sobre a criação de um ambiente de desenvolvimento e como fazer uma contribuição para good-first-issues , consulte as diretrizes contribuintes.