To set up the development environment to make changes to the code, clone the repo, install dependencies, and run it
directly with node as Docker doesn't expose as much.
To edit the code please keep a few things in mind:
- Be able to explain changes you make; they should be legible and understandable.
- Please try to abide by ESLint's rules, setting up ESLint is quite easy to do and not too difficult to follow.
For testing, make sure to set up the prerequisites:
- MongoDB: have a MongoDB server set up.
- Environment Variables: take a look at the
docker-compose.ymlfor examples.
Once that's done, you can run yarn tsc or npx tsc to build to JavaScript in the built directory. Here you'll
find deploy-commands.js which you need to deploy the slash commands, and index.js which you can run to start the
bot.
Creating a PR is easy enough and there are plenty of tutorials to do so. When contributing, please make sure to highlight and explain your change, with any import information additionally included.