Skip to content

Commit f90d51c

Browse files
dblythydplewis
authored andcommitted
Add Github process to contributing guide (#7105)
* Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Revert "Update CONTRIBUTING.md" This reverts commit 331d7dc. * Update CONTRIBUTING.md
1 parent dcc48ab commit f90d51c

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,20 @@
22

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

5+
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.
6+
7+
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.
8+
9+
When opening an issue, please make sure you follow the templates and provide as much detail as possible.
10+
11+
After you've completed the contribution, you'll need to submit a Pull Request (PR).
12+
513
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.
614

15+
If you need any help along the way, you can open a Draft PR where we can help finalize your contribution.
16+
17+
Contributing can be challenging, so don't be discouraged if you're having difficulties. Please don't hesitate to ask for help.
18+
719
## Setting up the project for debugging and contributing:
820

921
### Recommended setup:
@@ -53,6 +65,7 @@ Once you have babel running in watch mode, you can start making changes to parse
5365
* 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*.
5466
* Lint your code by running `npm run lint` to make sure the code is not going to be rejected by the CI.
5567
* **Do not** publish the *lib* folder.
68+
* 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.
5669

5770
### Run your tests against Postgres (optional)
5871

0 commit comments

Comments
 (0)