From 783de13ecc3337a308fe4b75f7bb1c372e34fb6a Mon Sep 17 00:00:00 2001 From: Florent Vilmart Date: Sun, 28 May 2017 11:23:11 -0400 Subject: [PATCH 1/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3e0d81de39..fe8501d8d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,21 @@ 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 `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 your tests against Postgres (optional) + +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. + +* Run the tests against the postgres database with `PARSE_SERVER_TEST_DB=postgres npm test`. You'll need to have postgres running on your machine an setup [appropriatedly](https://github.com/parse-community/parse-server/blob/master/.travis.yml#L37) +* If your feature is a mongoDB only feature and the test don't apply for a Postgres database, you can disable them with: + + - `describe_only_db('mongo')` // will create a `describe` that runs only on mongoDB + - `it_only_db('mongo')` // will make a test that only runs on mongo + - `it_exclude_dbs(['postgres'])` // will make a test that runs against all DB's but postgres + +     ##### Code of Conduct -This project adheres to the [Open Code of Conduct](http://todogroup.org/opencodeofconduct/#Parse Server/fjm@fb.com). By participating, you are expected to honor this code. +This project adheres to the [Contributor Covenant Code of Conduct](https://github.com/parse-community/parse-server/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to honor this code. From e6212f4a2cc9a55196a85e2d6e898d4f71f1818a Mon Sep 17 00:00:00 2001 From: Florent Vilmart Date: Sun, 28 May 2017 12:48:50 -0400 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fe8501d8d6..8bfedf9b32 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,14 +16,12 @@ We really want Parse to be yours, to see it grow and thrive in the open source c 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. -* Run the tests against the postgres database with `PARSE_SERVER_TEST_DB=postgres npm test`. You'll need to have postgres running on your machine an setup [appropriatedly](https://github.com/parse-community/parse-server/blob/master/.travis.yml#L37) -* If your feature is a mongoDB only feature and the test don't apply for a Postgres database, you can disable them with: +* Run the tests against the postgres database with `PARSE_SERVER_TEST_DB=postgres npm test`. You'll need to have postgres running on your machine and setup [appropriately](https://github.com/parse-community/parse-server/blob/master/.travis.yml#L37) +* If your feature is intended to only work with MongoDB, you should disable PostgreSQL-specific tests with: - `describe_only_db('mongo')` // will create a `describe` that runs only on mongoDB - `it_only_db('mongo')` // will make a test that only runs on mongo - `it_exclude_dbs(['postgres'])` // will make a test that runs against all DB's but postgres - -     ##### Code of Conduct