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
+10-8Lines changed: 10 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -7,8 +7,6 @@ When committing, keep all lines to less than 80 characters, and try to
7
7
follow the existing style. Before creating a pull request, squash your commits
8
8
into a single commit. Please provide ample explanation in the commit message.
9
9
10
-
In addition there's a pretty cool [class inheritance diagram](http://parseplatform.org/parse-php-sdk/graph_class.html) you can check out as well.
11
-
12
10
Installation
13
11
------------
14
12
@@ -28,15 +26,13 @@ To setup the Test Parse Server:
28
26
* Run `npm install` from the project root to download the server and it's dependencies.
29
27
* When you're ready to run tests use `npm start` from the project root to boot up the test server.
30
28
31
-
The embedded test server utilizes this [parse server test] project.
32
-
It's setup with the appropriate configuration to run the php sdk test suite.
33
-
Additionally it handles setting up mongodb for the server.
29
+
The test server is setup with the appropriate configuration to run the php sdk test suite. Additionally it handles setting up mongodb for the server. If you have a mongodb instance already running, you can use `npm run server-only`.
34
30
35
31
If you have specific needs and would like to alter your test server you can fork and modify the aforementioned test project.
36
32
Alternately you can configure a compatible test server as follows:
37
33
38
34
*[Setup a local Parse Server instance]
39
-
* Add main.js in tests/cloudcode/cloud/ to your Parse Server configuration as a cloud code file
35
+
* Add cloud-code.js in tests to your Parse Server configuration as a cloud code file
40
36
* Ensure your App ID, REST API Key, and Master Key match those contained in tests/Parse/Helper.php
41
37
* Add a mock push configuration, for example:
42
38
```json
@@ -70,6 +66,10 @@ You may also run tests directly using phpunit as follows:
70
66
71
67
npm test
72
68
69
+
For debugging you can use the `print` function found in tests/Parse/Helper.php
70
+
71
+
Helper::print()
72
+
73
73
Make sure your code is linted with phpcs ([PSR-2 Coding Style]):
74
74
75
75
npm run lint
@@ -90,11 +90,13 @@ If you do not have XDebug tests will still run, just without coverage.
90
90
Please make sure that any new functionality (or issues) you are working on are covered by tests when possible.
91
91
If you have XDebug setup and can view code coverage please ensure that you do your best to completely cover any new code you are adding.
92
92
93
+
## Code of Conduct
94
+
95
+
This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to honor this code.
0 commit comments