diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 85f28c3379..9a2710e6ac 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -20,12 +20,15 @@ Fixes # (issue) - [ ] Test A - [ ] Test B -## Checklist: +## Checklist -- [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my own code and corrected any misspellings -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] My changes generate no new warnings -- [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing unit tests pass locally with my changes + + +- I haven't read the [contributing guide](https://github.com/calcom/cal.com/blob/main/CONTRIBUTING.md) +- My code doesn't follow the style guidelines of this project +- I haven't performed a self-review of my own code and corrected any misspellings +- I haven't commented my code, particularly in hard-to-understand areas +- I haven't checked if my PR needs changes to the documentation +- I haven't checked if my changes generate no new warnings +- I haven't added tests that prove my fix is effective or that my feature works +- I haven't checked if new and existing unit tests pass locally with my changes diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..1694468fd0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,79 @@ +# 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. + +## 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 biweekly. + +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 + +More info on how to add new tests comming 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 comitting. + +## 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. diff --git a/README.md b/README.md index 925b32a38f..8cc9a77247 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,6 @@ Cal officially launched as v.1.0 on 15th of September, however a lot of new feat ![cal-star-github](https://user-images.githubusercontent.com/8019099/154853944-a9e3c999-3da3-4048-b149-b4f73893c6fb.gif) - ## Getting Started @@ -279,14 +278,11 @@ See the [open issues](https://github.com/calcom/cal.com/issues) for a list of pr ## Contributing -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**. +Please see our [contributing guide](/CONTRIBUTING.md). -1. Fork the project -2. Create your feature branch (`git checkout -b feature/AmazingFeature`) -3. Make your changes -4. Commit your changes (`git commit -m 'Add some AmazingFeature'`) -5. Push to the branch (`git push origin feature/AmazingFeature`) -6. Open a pull request +### Good First Issues + +We have a list of [good first issues](https://github.com/calcom/cal.com/labels/✅%20good%20first%20issue) that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process. ## Integrations