Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Github process to contributing guide #7105

Merged
merged 5 commits into from
Feb 12, 2021
Merged

Add Github process to contributing guide #7105

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b17b58c
Update CONTRIBUTING.md
dblythy Jan 3, 2021
2fe7bd3
Update CONTRIBUTING.md
dblythy Jan 3, 2021
331d7dc
Update CONTRIBUTING.md
dblythy Jan 31, 2021
9f4713c
Revert "Update CONTRIBUTING.md"
dblythy Feb 11, 2021
db750e8
Update CONTRIBUTING.md
dblythy Feb 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,20 @@

We really want Parse to be yours, to see it grow and thrive in the open source community.

Before you jump into the coding element of contributing, please make sure you first [open an issue](https://github.com/parse-community/parse-server/issues/new/choose) relating to your contribution, or continue the discussion in the existing issue.

This helps us all plan out the best conceptual approach for the contribution, so that your time isn't wasted on approaches or features that could be tackled in a different way. Our team are also happy to give you pointers and suggestions to speed up the process.

When opening an issue, please make sure you follow the templates and provide as much detail as possible.

After you've completed the contribution, you'll need to submit a Pull Request (PR).

If you are not familiar with Pull Requests and want to know more about them, you can visit the [Creating a pull request](https://help.github.com/articles/creating-a-pull-request/) article. It contains detailed informations about the process.

If you need any help along the way, you can open a Draft PR where we can help finalize your contribution.

Contributing can be challenging, so don't be discouraged if you're having difficulties. Please don't hesitate to ask for help.

## Setting up the project for debugging and contributing:

### Recommended setup:
Expand Down Expand Up @@ -53,6 +65,7 @@ Once you have babel running in watch mode, you can start making changes to parse
* Run the tests for the whole project to make sure the code passes all tests. This can be done by running the test command for a single file but removing the test file argument. The results can be seen at *<PROJECT_ROOT>/coverage/lcov-report/index.html*.
* Lint your code by running `npm run lint` to make sure the code is not going to be rejected by the CI.
* **Do not** publish the *lib* folder.
* Please consider if any changes to the [docs](http://docs.parseplatform.org) are needed or add additional sections in the case of an enhancement or feature.

### Run your tests against Postgres (optional)

Expand Down