CONTRIBUTING.md

Contributing

Opening an issue

Testing your new features

After cloning the repository you should install the dependencies by using

$ yarn install

You have to create an OAuth application from Discord Developer Portal. After creating your application create a bot and enable Server Members Intent and Message Content Intent from Privileged Gateway Intents.

Copy the .env.example and rename it to .env, fill all variables correspondingly. Run the command below to sync your db with the current schema.prisma.

$ yarn run sync

And you're done! You can test your changes with the bot.

⚠ DON'T FORGET TO SET YOUR NODE_ENV TO development

Committing your changes

This repository follows Conventional Commits v1.0.0. By default, the husky git hook should error your commit if your commit message is malformed, but if you have git hooks disabled it won't. So don't forget to follow Conventional Commits specifications

Setting up your IDE

VS Code

As the repo uses a dev branch of TypeScript, you have to set it manually to the one installed in node_modules.

Open the command palette by Ctrl/Cmd + Shift + P. Then choose Typescript: Select TypeScript version...

then select Use Workspace Version