Thank you for considering to contribute to this project.
First off, there are some simple rules. The following apply:
- Do not propose any significant changes without prior testing.
- Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get feedback.
- Be respectful when discussing code changes.
Other than the above rules, have at it. Make your code as readible and efficiant as possible. Explain it if it starts to get complex.
You might want to know how to set up an environment to develop.
Basically,
- Clone the repo locally
- Install the dependancies
yarn install
- Change what's needed in
.env.example
and maybe rename it to.env
- Run the dev command or run directly
yarn run dev
nodemon -r dotenv/config -r tsconfig-paths/register src/Bot.ts
- There you go!