CONTRIBUTING.md

Contributing to Cal.com

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.

Areas of expertise

Legend

✅ = has knowledge

🥇 = is their main priority

⚠️ = is the only one with knowledge

👀 = has no knowledge but wants to be onboarded

Developing

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:

   yarn

5. Start developing and watch for code changes:

   yarn dev

Building

You can build the project with:

yarn build

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

Testing

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

Linting

To check the formatting of your code:

yarn lint

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

Making a Pull Request

• Be sure to check the "Allow edits from maintainers" option while creating you PR.
• If your PR refers to or fixes an issue, be sure to add refs #XXX or fixes #XXX to the PR description. Replacing XXX with the respective issue number. Se more about Linking a pull request to an issue .
• Be sure to fill the PR Template accordingly.