Contribution guide

We are happy that you are interested in contributing to our project. This guide will help you to get started with the development of our project. We are always looking for new contributors and are happy to help you with any questions you might have. If you have any questions or need help please contact us!

Formatting

We use a number of eslint and prettier rules to ensure a consistent code style. Please run the following commands before submitting a pull request:

pnpm -r lint

This runs eslint and prettier on all packages. You may also run the commands in a specific package:

cd packages/auth
pnpm eslint .

Submitting changes

Please create a new branch for your changes, and submit a pull request to the main branch. We will review your changes and provide feedback.

Testing

Where possible we try to provide tests for our code. We used Jest but are now migrating to vitest as our testing framework. For now code please use vitest. Tests mostly exist for unit tests and http requests. Frontend code is currently not tested if you are interested and have some strong opinions on how to test frontend code please let us know.

To run the tests locally you can use the following commands:

# Run all tests
pnpm test

# Run tests for a specific package
cd packages/auth
pnpm test