Skip to content

Commit a269f9e

Browse files
authored
docs: Improve Contributing Guide (#508)
1 parent a0957c1 commit a269f9e

File tree

2 files changed

+10
-69
lines changed

2 files changed

+10
-69
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ When committing, keep all lines to less than 80 characters, and try to
77
follow the existing style. Before creating a pull request, squash your commits
88
into a single commit. Please provide ample explanation in the commit message.
99

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-
1210
Installation
1311
------------
1412

@@ -28,15 +26,13 @@ To setup the Test Parse Server:
2826
* Run `npm install` from the project root to download the server and it's dependencies.
2927
* When you're ready to run tests use `npm start` from the project root to boot up the test server.
3028

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`.
3430

3531
If you have specific needs and would like to alter your test server you can fork and modify the aforementioned test project.
3632
Alternately you can configure a compatible test server as follows:
3733

3834
* [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
4036
* Ensure your App ID, REST API Key, and Master Key match those contained in tests/Parse/Helper.php
4137
* Add a mock push configuration, for example:
4238
```json
@@ -70,6 +66,10 @@ You may also run tests directly using phpunit as follows:
7066

7167
npm test
7268

69+
For debugging you can use the `print` function found in tests/Parse/Helper.php
70+
71+
Helper::print()
72+
7373
Make sure your code is linted with phpcs ([PSR-2 Coding Style]):
7474

7575
npm run lint
@@ -90,11 +90,13 @@ If you do not have XDebug tests will still run, just without coverage.
9090
Please make sure that any new functionality (or issues) you are working on are covered by tests when possible.
9191
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.
9292

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.
96+
9397
[Get Composer]: https://getcomposer.org/download/
9498
[Get npm]: https://www.npmjs.com/get-npm
95-
[Contributor License Agreement]: https://developers.facebook.com/opensource/cla
9699
[XDebug]: https://xdebug.org/
97-
[parse server test]: https://github.com/montymxb/parse-server-test
98100
[Setup a local Parse Server instance]: https://github.com/parse-community/parse-server#user-content-locally
99101
[PSR-2 Coding Style]: http://www.php-fig.org/psr/psr-2/
100102

tests/cloudcode/cloud/main.js

Lines changed: 0 additions & 61 deletions
This file was deleted.

0 commit comments

Comments
 (0)