From 45b105ea0f3dc0667056c0c53f569daf4a7ac16a Mon Sep 17 00:00:00 2001 From: Addison Elliott Date: Mon, 20 Nov 2017 15:02:11 -0600 Subject: [PATCH 1/3] Update CONTRIBUTING.md Clean up some of the language in the document. Add command to run for testing on Windows --- CONTRIBUTING.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8bfedf9b32..1a3604e751 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,11 +6,14 @@ We really want Parse to be yours, to see it grow and thrive in the open source c ##### Please Do's +* 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. * Take testing seriously! Aim to increase the test coverage with every pull request. -* Run the tests for the file you are working on with `npm test spec/MyFile.spec.js` -* 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 -* Lint your code by running `npm run lint` to make sure all your code is not gonna be rejected by the CI. -* Never publish the lib folder. +* Run the tests for the file you are working on with the following command: + * **Windows**: `npm run test:win spec/MyFile.spec.js` + * **Unix**: `npm test spec/MyFile.spec.js` +* 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 */lcov-report/parse-server/FileUnderTest.js.html*. +* Lint your code by running `npm run lint` to make sure the code is not going to be rejected by the CI. +* **Do not** publish the *lib* folder. ##### Run your tests against Postgres (optional) From 24a92eb3cabc1d99d9fd88520cad493a0c5030a1 Mon Sep 17 00:00:00 2001 From: Addison Elliott Date: Mon, 20 Nov 2017 15:26:22 -0600 Subject: [PATCH 2/3] Update CONTRIBUTING.md Update coverage directory --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1a3604e751..eacc6356a8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ We really want Parse to be yours, to see it grow and thrive in the open source c * Run the tests for the file you are working on with the following command: * **Windows**: `npm run test:win spec/MyFile.spec.js` * **Unix**: `npm test spec/MyFile.spec.js` -* 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 */lcov-report/parse-server/FileUnderTest.js.html*. +* 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 */coverage/lcov-report/index.html*. * Lint your code by running `npm run lint` to make sure the code is not going to be rejected by the CI. * **Do not** publish the *lib* folder. From ea3453642cbf50a189ea5ab75a876c3ea1abaa3f Mon Sep 17 00:00:00 2001 From: Addison Elliott Date: Tue, 21 Nov 2017 08:15:57 -0600 Subject: [PATCH 3/3] Update CONTRIBUTING.md Add details about how to run test coverage --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index eacc6356a8..f6a907f832 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,9 @@ We really want Parse to be yours, to see it grow and thrive in the open source c ##### Please Do's * 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. -* Take testing seriously! Aim to increase the test coverage with every pull request. +* Take testing seriously! Aim to increase the test coverage with every pull request. To obtain the test coverage of the project, run: + * **Windows**: `npm run coverage:win` + * **Unix**: `npm run coverage` * Run the tests for the file you are working on with the following command: * **Windows**: `npm run test:win spec/MyFile.spec.js` * **Unix**: `npm test spec/MyFile.spec.js`