Skip to content

Latest commit

 

History

History
230 lines (169 loc) · 7.08 KB

CONTRIBUTING.md

File metadata and controls

230 lines (169 loc) · 7.08 KB
Raw

Contributing to Cal.com

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

House rules

  • Before submitting a new issue or PR, check if it already exists in issues or PRs.
  • GitHub issues: take note of the 🚨 needs approval label.
    • For Contributors:
      • Feature Requests: Wait for a core member to approve and remove the 🚨 needs approval label before you start coding or submit a PR.
      • Bugs, Security, Performance, Documentation, etc.: You can start coding immediately, even if the 🚨 needs approval label is present. This label mainly concerns feature requests.
    • Our Process:
      • Issues from non-core members automatically receive the 🚨 needs approval label.
      • We greatly value new feature ideas. To ensure consistency in the product's direction, they undergo review and approval.

Priorities

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

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. Set up your .env file:

    • Duplicate .env.example to .env.
    • Use openssl rand -base64 32 to generate a key and add it under NEXTAUTH_SECRET in the .env file.
    • Use openssl rand -base64 32 to generate a key and add it under CALENDSO_ENCRYPTION_KEY in the .env file.

  6. Setup Node If your Node version does not meet the project's requirements as instructed by the docs, "nvm" (Node Version Manager) allows using Node at the version required by the project:

    nvm use

    You first might need to install the specific version and then use it:

    nvm install && nvm use

    You can install nvm from here.

  7. 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

Resolving issues

E2E test browsers not installed

Run npx playwright install to download test browsers and resolve the error below when running yarn test-e2e:

Executable doesn't exist at /Users/alice/Library/Caches/ms-playwright/chromium-1048/chrome-mac/Chromium.app/Contents/MacOS/Chromium

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

Guidelines for committing yarn lockfile

Do not commit your yarn.lock unless you've made changes to the package.json. If you've already committed yarn.lock unintentionally, follow these steps to undo:

If your last commit has the yarn.lock file alongside other files and you only wish to uncommit the yarn.lock:

git checkout HEAD~1 yarn.lock
git commit -m "Revert yarn.lock changes"

NB: You may have to bypass the pre-commit hook with by appending --no-verify to the git commit If you've pushed the commit with the yarn.lock:

  1. Correct the commit locally using the above method.
  2. Carefully force push:
git push origin <your-branch-name> --force

If yarn.lock was committed a while ago and there have been several commits since, you can use the following steps to revert just the yarn.lock changes without impacting the subsequent changes:

  1. Checkout a Previous Version:

    • Find the commit hash before the yarn.lock was unintentionally committed. You can do this by viewing the Git log:

      git log yarn.lock

    • Once you have identified the commit hash, use it to checkout the previous version of yarn.lock:

      git checkout <commit_hash> yarn.lock

  2. Commit the Reverted Version:

    • After checking out the previous version of the yarn.lock, commit this change:

      git commit -m "Revert yarn.lock to its state before unintended changes"

  3. Proceed with Caution:

    • If you need to push this change, first pull the latest changes from your remote branch to ensure you're not overwriting other recent changes:

      git pull origin <your-branch-name>

    • Then push the updated branch:

      git push origin <your-branch-name>

Lastly, make sure to keep the branches updated (e.g. click the Update branch button on GitHub PR).