Skip to content

Commit bbf3063

Browse files
addisonElliottflovilmart
authored andcommitted
Update contributing.md (parse-community#4368)
* Update CONTRIBUTING.md Clean up some of the language in the document. Add command to run for testing on Windows * Update CONTRIBUTING.md Update coverage directory * Update CONTRIBUTING.md Add details about how to run test coverage
1 parent 397caa0 commit bbf3063

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

CONTRIBUTING.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,16 @@ We really want Parse to be yours, to see it grow and thrive in the open source c
66

77
##### Please Do's
88

9-
* Take testing seriously! Aim to increase the test coverage with every pull request.
10-
* Run the tests for the file you are working on with `npm test spec/MyFile.spec.js`
11-
* Run the tests for the whole project and look at the coverage report to make sure your tests are exhaustive by running `npm test` and looking at (project-root)/lcov-report/parse-server/FileUnderTest.js.html
12-
* Lint your code by running `npm run lint` to make sure all your code is not gonna be rejected by the CI.
13-
* Never publish the lib folder.
9+
* 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+
* Take testing seriously! Aim to increase the test coverage with every pull request. To obtain the test coverage of the project, run:
11+
* **Windows**: `npm run coverage:win`
12+
* **Unix**: `npm run coverage`
13+
* Run the tests for the file you are working on with the following command:
14+
* **Windows**: `npm run test:win spec/MyFile.spec.js`
15+
* **Unix**: `npm test spec/MyFile.spec.js`
16+
* 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*.
17+
* Lint your code by running `npm run lint` to make sure the code is not going to be rejected by the CI.
18+
* **Do not** publish the *lib* folder.
1419

1520
##### Run your tests against Postgres (optional)
1621

0 commit comments

Comments
 (0)