Whether it is for a bug fix, a new feature or a typo in the documentation, any help is more than welcome!
If you think you found a bug, please check in the past issues if it has not been already reported before filing a new one.
First you can clone the project, then install all the dependencies: npm install or yarn install.
You can now start working by running npm run dev or yarn dev.
The project is using Vite as a local server.
The code is written in Typescript and is using eslint and prettier.
The documentation is automatically generated by Typedoc when building the project. If you need to add a new class, method or property, please add the corresponding typedoc comments, so it can be included in the doc as well.
Before submitting any PR, you must ensure the project is building without throwing any error by running npm run build or yarn build. Please add a detailed description of your PR.
If your PR includes a new feature, it would be highly appreciated that you'd add at least a test case to the /tests/ directory:
If you have any question about how the code is structured, or any suggestion on a refactoring, new feature, or anything else, feel free to open a new discussion on the topic.