Based on the calcom contribution 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.
The development branch is main
. This is the branch that all pull requests should be made against.
To develop locally:
-
Fork this repository to your own GitHub account and then clone it to your local device.
-
Create a new branch:
git checkout -b MY_BRANCH_NAME
-
Install yarn:
npm install -g yarn
-
Install the dependencies with:
yarn
-
Setup a local development environment for supabase
- Follow the steps here to set up a local supabase instance
Preqrequisites:
- Docker Desktop
- Supabase CLI
-
Set up your
.env
file:- Duplicate
.env.example
to.env
. - Enter your supabase credentials in the
.env
file.
- Duplicate
-
Start developing and watch for code changes:
yarn dev
This will start a local server at
http://localhost:3000
and watch for changes in the code. The server will automatically reload when changes are made.
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.
- 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
orfixes #XXX
to the PR description. ReplacingXXX
with the respective issue number. See more about Linking a pull request to an issue . - Be sure to fill the PR Template accordingly.