angolaosc / savanna-bot

A discord bot to find github's good first issue on different repositories.

SavannaBot

A discord bot to find Github's good first issue on different repositories.

Get it

You can add the bot to your server by clicking on

How to use

• /svn <param>: <your query> - Search for good first issues on GitHub

Example: /svn language:python

The query parameters are the same as the ones used on GitHub's search bar. See the full list here.

Some of the most used parameters are:

• owner - Filter by the user that created the issue.
• language - Filter by the language the repository is written in.
• label - Filter by the labels applied to the issue.
• state - Filter by the state of the issue.
• repo - Filter by the repository the issue belongs to.

You can also use any combination of the parameters above.

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

Configuration

• You will need your discord bot token. See how to get yours here
• And your GitHub developer token. See how to get yours here

Now you need to change the .env-example to .env, with the following content.

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

Run Locally

Clone the project

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

Go to the project directory:

  cd savanna-bot

Create your virtual environment:

  virtualenv env

and

  source venv/bin/activate (in Linux)

Install the dependencies

  pip install -r requirements.txt

Now you are ready to go, run

  python3 src/bot.py

Contributing

Contributions are always welcome!

See CONTRIBUTING.md for ways to get started.

License

Savanna-bot is licensed under the 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.