You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Removes need to use babel-register
- Adds watch to watch changes when running the test to regenerate
- Tests are now pure node 8
* Adds timing to helper.js
* Update contribution guide
* Adds inline sourcemaps generation to restore coverage
* nits
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+45-6Lines changed: 45 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,49 @@
1
-
###Contributing to Parse Server
1
+
# Contributing to Parse Server
2
2
3
-
#### Pull Requests Welcome!
3
+
We really want Parse to be yours, to see it grow and thrive in the open source community.
4
4
5
-
We really want Parse to be yours, to see it grow and thrive in the open source community.
5
+
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.
6
6
7
-
##### Please Do's
7
+
## Setting up the project for debugging and contributing:
8
+
9
+
### Recommended setup:
10
+
11
+
*[vscode](https://code.visualstudio.com), the popular IDE.
12
+
*[Jasmine Test Explorer](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-test-explorer), a very practical test exploration plugin which let you run, debug and see the test results inline.
13
+
14
+
### Setting up you local machine:
15
+
16
+
*[Fork](https://github.com/parse-community/parse-server) this project and clone the fork on your local machine:
$ npm run watch # run babel watching for local file changes
24
+
```
25
+
26
+
Once you have babel running in watch mode, you can start making changes to parse-server.
27
+
28
+
### Good to know:
29
+
30
+
* The lib/ folder is not commited, so never make changes in there.
31
+
* Always make changes to files in the `src/` folder.
32
+
* All the tests should point to sources in the `lib/` folder.
33
+
34
+
### Troubleshooting:
35
+
36
+
*Question*: I modify the code in the src folder but it doesn't seem to have any effect.<br/>
37
+
*Answer*: Check that `npm run watch` is running
38
+
39
+
*Question*: How do I use breakpoints and debug step by step?<br/>
40
+
*Answer*: The easiest way is to install [Jasmine Test Explorer](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-test-explorer), it will let you run selectively tests and debug them.
41
+
42
+
*Question*: How do I deploy my forked version on my servers?<br/>
43
+
*Answer*: In your `package.json`, update the `parse-server` dependency to `https://github.com/MY_USERNAME/parse-server#MY_FEATURE`. Run `npm install`, commit the changes and deploy to your servers.
44
+
45
+
46
+
### Please Do's
8
47
9
48
* Begin by reading the [Development Guide](http://docs.parseplatform.org/parse-server/guide/#development-guide) to learn how to get started running the parse-server.
10
49
* Take testing seriously! Aim to increase the test coverage with every pull request. To obtain the test coverage of the project, run:
@@ -17,7 +56,7 @@ We really want Parse to be yours, to see it grow and thrive in the open source c
17
56
* Lint your code by running `npm run lint` to make sure the code is not going to be rejected by the CI.
18
57
***Do not** publish the *lib* folder.
19
58
20
-
#####Run your tests against Postgres (optional)
59
+
### Run your tests against Postgres (optional)
21
60
22
61
If your pull request introduces a change that may affect the storage or retrieval of objects, you may want to make sure it plays nice with Postgres.
23
62
@@ -28,6 +67,6 @@ If your pull request introduces a change that may affect the storage or retrieva
28
67
-`it_only_db('mongo')` // will make a test that only runs on mongo
29
68
-`it_exclude_dbs(['postgres'])` // will make a test that runs against all DB's but postgres
30
69
31
-
#####Code of Conduct
70
+
### Code of Conduct
32
71
33
72
This project adheres to the [Contributor Covenant Code of Conduct](https://github.com/parse-community/parse-server/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to honor this code.
0 commit comments