CONTRIBUTING.md

Guidelines for Contributing

This guideline is heavily based on The GLHF Pledge and CONTRIBUTING.rst of github3.py project.

1. Be a good, responsible, and mature sport
2. Remember that people online and in virtual spaces are still real people.
3. Know that my actions and words can have real impact.
4. Regardless of how big or small is your change, add your name to the AUTHORS.md.
5. Test your code before you push, no matter how big or small your change is.
6. Rebase your fork/branch before you merge. If you don't know what this is or how to do this, ask for help.

How to set up your local development environment

This instructions describe for the people who has never set up a Python development environment and provides what the Python development community considers as the best practice. Depending on your prior knowledge, you may skip some steps here and there. Depending on your preference, you may choose not to follow the steps. However, keep in mind that TAC_bot_db is set up to be developed using the below instructions.

1. Download and install the latest version of Python 3.
2. After the installation, verify you have pip installed and available from your path.
   • $ pip --version should return the version number and the location of the executable.
3. Update the pip to the latest version: $ pip install pip --upgrade
4. Install pipenv via pip: $ pip install pipenv
5. Using pipenv, create an environment for TAC_bot_db: $ pipenv --three
6. Install all dependencies using pipenv: $ pipenv install
7. Activate the environment created by pipenv: $ pipenv shell
8. Set the Discord bot token as the environment variable
   • On Unix-like environment: $ export DISCORD_BOT_TOKEN='MyDiscordBot'
   • On Windows environment: C:\TAC_bot_db> set DISCORD_BOT_TOKEN='MyDiscordBot'
9. Run the bot: $ python discord_bot/Bot.py