Readme em portugues.md

SavannaBot

Um bot do Discord para encontrar boas primeiras issues no GitHub em diferentes repositórios.

Vamos a isso:

Você pode adicionar o bot ao seu servidor clicando em

Como Usar

• /svn <param>: <your query> - Buscar boas primeiras issues no GitHub

Exemplo: /svn language:python Os parâmetros da consulta são os mesmos usados na barra de pesquisa do GitHub. Veja a lista completa here.

Alguns dos parâmetros mais usados são:

• owner - Filtrar pelo usuário que criou a issue.
• language - Filtrar pela linguagem em que o repositório está escrito.
• label - Filtrar pelas labels aplicadas à issue.
• state - Filtrar pelo estado da issue.
• repo - Filtrar pelo repositório ao qual a issue pertence.

Você também pode usar qualquer combinação dos parâmetros acima.

Exemplo: /svn owner:angolaosc language:python repo:angolaosc/savanna-bot

Configuração

• Você precisará do token do seu bot do Discord. Veja como obtê-lo aqui aqui
• E do token de desenvolvedor do GitHub. Veja como obter o seu aqui

Agora, você precisa alterar o arquivo .env-example para .env, com o seguinte conteúdo.

  GITHUB_TOKEN=<your GitHub developer access token>
  BOT_TOKEN=<your discord bot token>

Executar localmente

Clone o repositorio

  git clone https://github.com/angolaosc/savanna-bot.git

Vá para o diretório do projeto:

  cd savanna-bot

Crie seu ambiente virtual:

  virtualenv env

e

  source venv/bin/activate (in Linux)

Instale as dependências

  pip install -r requirements.txt

Agora você está pronto para ir, execute

  python3 src/bot.py

Contribuição

Contribuições são sempre bem-vindas!

Veja CONTRIBUTING.mdpara saber como começar.

Licença

Savanna-bot está licenciado sob a Apache License, Version 2.0

---

Savanna-bot is a Angola Open-source Community open project.

Code of Conduct(CoC)

Please note Savanna-bot follows the AOSC Code of Conduct. By participating in this project, you agree to follow its terms.