Contribution Guide

Contributing to the Python Discord Bot

The guide will detail the steps necessary to develop, run, and test this bot locally as well as submit merge requests with your code changes.

Clone the repository

If you are not a collaborator on the project, you will need to fork this repo and make local clone of your fork

Setup Local Development Environment

This bot runs in Python which should allow you to setup any Python capable IDE you wish as long as you are using the correct version of Python

1. Install desired Python IDE (VSCode is good)
2. Install Git
3. Install Python >=3.8
4. Install dependencies with pip install -r requirements.txt

Setup Test Server

Setup a bot account

Configure the bot

Run the bot

The end goal of the bot project is to be able to run it in a Docker contain. For now, the bot must be run locally from the host filesystem itself. You can either run the bot with a direct Python command or in a Screen session

• python discord_bot.py

or

• screen -S discordbot python discord_bot.py

Working and Issue

1. Open the issue
2. Click the link to create a branch from the issue
3. Use the defaults for naming the branch, etc.
4. Go to your editor and Fetch
5. Switch to the branch you just created
6. Work

Creating a plugin