Contributor's guide

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  • Before jumping into a PR be sure to search existing PRs or issues for an open or closed item that relates to your submission.


Type of issuePriority
Minor improvements, non-core feature requests
Confusing UX (... but working)
Core Features (Booking page, availabilty, timezone calculation)
Core Bugs (Login, Booking page, Emails are not working)


The development branch is main. This is the branch that all pull requests should be made against. The changes on the main branch are tagged into a release monthly.

To develop locally:

  1. Fork this repository to your own GitHub account and then clone it to your local device.

  2. Create a new branch:

    git checkout -b MY_BRANCH_NAME
  3. Install yarn:

    npm install -g yarn
  4. Install the dependencies with:

  5. Start developing and watch for code changes:

    yarn dev


You can build the project with:

yarn build

Please be sure that you can make a full production build before pushing code.


More info on how to add new tests coming soon.

Running tests

This will run and test all flows in multiple Chromium windows to verify that no critical flow breaks:

yarn test-e2e


To check the formatting of your code:

yarn lint

If you get errors, be sure to fix them before committing.

Making a Pull Request

Was this page helpful?