cal.pub0.org/CONTRIBUTING.md

97 lines
2.5 KiB
Markdown
Raw Normal View History

# Contributing to Cal.com
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
- Before jumping into a PR be sure to search [existing PRs](https://github.com/calcom/cal.com/pulls) or [issues](https://github.com/calcom/cal.com/issues) for an open or closed item that relates to your submission.
2022-05-28 16:35:07 +00:00
## Areas of expertise
2022-05-28 18:50:52 +00:00
### Legend
2022-05-30 10:37:57 +00:00
2022-06-24 13:37:56 +00:00
✅ = has knowledge
2022-05-30 10:37:57 +00:00
🥇 = is their main priority
2022-06-24 13:37:56 +00:00
⚠️ = is the only one with knowledge
2022-05-30 10:37:57 +00:00
2022-06-24 13:37:56 +00:00
👀 = has no knowledge but wants to be onboarded
2022-05-30 10:37:57 +00:00
2022-05-30 10:44:28 +00:00
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://dynamic-svgs.vercel.app/image.svg?dark">
<img alt="Areas of expertise table" src="https://dynamic-svgs.vercel.app/image.svg">
</picture>
2022-05-30 10:37:57 +00:00
## Developing
The development branch is `main`. This is the branch that all pull
requests should be made against. The changes on the `main`
2022-03-03 09:54:51 +00:00
branch are tagged into a release monthly.
To develop locally:
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your
own GitHub account and then
[clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
2. Create a new branch:
```sh
git checkout -b MY_BRANCH_NAME
```
3. Install yarn:
```sh
npm install -g yarn
```
4. Install the dependencies with:
```sh
yarn
```
5. Start developing and watch for code changes:
```sh
yarn dev
```
## Building
You can build the project with:
```bash
yarn build
```
Please be sure that you can make a full production build before pushing code.
## Testing
2022-03-03 09:54:51 +00:00
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:
```sh
yarn test-e2e
```
## Linting
To check the formatting of your code:
```sh
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](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork) 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
](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
- Be sure to fill the PR Template accordingly.