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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+26-25Lines changed: 26 additions & 25 deletions
Original file line number
Diff line number
Diff line change
@@ -8,12 +8,12 @@ If you are not familiar with Pull Requests and want to know more about them, you
8
8
9
9
### Recommended setup:
10
10
11
-
*[vscode](https://code.visualstudio.com), the popular IDE.
12
-
*[Jasmine Test Explorer](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-jasmine-test-adapter), a very practical test exploration plugin which let you run, debug and see the test results inline.
11
+
-[vscode](https://code.visualstudio.com), the popular IDE.
12
+
-[Jasmine Test Explorer](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-jasmine-test-adapter), a very practical test exploration plugin which let you run, debug and see the test results inline.
13
13
14
14
### Setting up you local machine:
15
15
16
-
*[Fork](https://github.com/parse-community/parse-server) this project and clone the fork on your local machine:
16
+
-[Fork](https://github.com/parse-community/parse-server) this project and clone the fork on your local machine:
@@ -29,44 +29,44 @@ Once you have babel running in watch mode, you can start making changes to parse
29
29
30
30
### Good to know:
31
31
32
-
* The `lib/` folder is not commited, so never make changes in there.
33
-
* Always make changes to files in the `src/` folder.
34
-
* All the tests should point to sources in the `lib/` folder.
32
+
- The `lib/` folder is not commited, so never make changes in there.
33
+
- Always make changes to files in the `src/` folder.
34
+
- All the tests should point to sources in the `lib/` folder.
35
35
36
36
### Troubleshooting:
37
37
38
-
*Question*: I modify the code in the src folder but it doesn't seem to have any effect.<br/>
39
-
*Answer*: Check that `npm run watch` is running
38
+
_Question_: I modify the code in the src folder but it doesn't seem to have any effect.<br/>
39
+
_Answer_: Check that `npm run watch` is running
40
40
41
-
*Question*: How do I use breakpoints and debug step by step?<br/>
42
-
*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.
43
-
44
-
*Question*: How do I deploy my forked version on my servers?<br/>
45
-
*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.
41
+
_Question_: How do I use breakpoints and debug step by step?<br/>
42
+
_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.
46
43
44
+
_Question_: How do I deploy my forked version on my servers?<br/>
45
+
_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.
47
46
48
47
### Please Do's
49
48
50
-
* 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.
51
-
* Take testing seriously! Aim to increase the test coverage with every pull request. To obtain the test coverage of the project, run: `npm run coverage`
52
-
* Run the tests for the file you are working on with the following command: `npm test spec/MyFile.spec.js`
53
-
* 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*.
54
-
* Lint your code by running `npm run lint` to make sure the code is not going to be rejected by the CI.
55
-
***Do not** publish the *lib* folder.
49
+
- 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.
50
+
- Take testing seriously! Aim to increase the test coverage with every pull request. To obtain the test coverage of the project, run: `npm run coverage`
51
+
- Run the tests for the file you are working on with the following command: `npm test spec/MyFile.spec.js`
52
+
- 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_.
53
+
- Lint your code by running `npm run lint` to make sure the code is not going to be rejected by the CI.
54
+
-**Do not** publish the _lib_ folder.
56
55
57
56
### Run your tests against Postgres (optional)
58
57
59
58
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.
60
59
61
-
* Run the tests against the postgres database with `PARSE_SERVER_TEST_DB=postgres PARSE_SERVER_TEST_DATABASE_URI=postgres://postgres:password@localhost:5432/parse_server_postgres_adapter_test_database npm run testonly`. You'll need to have postgres running on your machine and setup [appropriately](https://github.com/parse-community/parse-server/blob/master/.travis.yml#L43) or use [`Docker`](#run-a-parse-postgres-with-docker).
62
-
* The Postgres adapter has a special debugger that traces all the sql commands. You can enable it with setting the environment variable `PARSE_SERVER_LOG_LEVEL=debug`
63
-
* If your feature is intended to only work with MongoDB, you should disable PostgreSQL-specific tests with:
60
+
- Run the tests against the postgres database with `PARSE_SERVER_TEST_DB=postgres PARSE_SERVER_TEST_DATABASE_URI=postgres://postgres:password@localhost:5432/parse_server_postgres_adapter_test_database npm run testonly`. You'll need to have postgres running on your machine and setup [appropriately](https://github.com/parse-community/parse-server/blob/master/.travis.yml#L43) or use [`Docker`](#run-a-parse-postgres-with-docker).
61
+
- The Postgres adapter has a special debugger that traces all the sql commands. You can enable it with setting the environment variable `PARSE_SERVER_LOG_LEVEL=debug`
62
+
- If your feature is intended to only work with MongoDB, you should disable PostgreSQL-specific tests with:
64
63
65
64
-`describe_only_db('mongo')` // will create a `describe` that runs only on mongoDB
66
65
-`it_only_db('mongo')` // will make a test that only runs on mongo
67
66
-`it_exclude_dbs(['postgres'])` // will make a test that runs against all DB's but postgres
68
-
* Similarly, if your feature is intended to only work with PostgreSQL, you should disable MongoDB-specific tests with:
69
-
67
+
68
+
- Similarly, if your feature is intended to only work with PostgreSQL, you should disable MongoDB-specific tests with:
69
+
70
70
-`describe_only_db('postgres')` // will create a `describe` that runs only on postgres
71
71
-`it_only_db('postgres')` // will make a test that only runs on postgres
72
72
-`it_exclude_dbs(['mongo'])` // will make a test that runs against all DB's but mongo
@@ -75,9 +75,10 @@ If your pull request introduces a change that may affect the storage or retrieva
75
75
76
76
[PostGIS images (select one with v2.2 or higher) on docker dashboard](https://hub.docker.com/r/postgis/postgis) is based off of the official [postgres](https://registry.hub.docker.com/_/postgres/) image and will work out-of-the-box (as long as you create a user with the necessary extensions for each of your Parse databases; see below). To launch the compatible Postgres instance, copy and paste the following line into your shell:
0 commit comments