Skip to content

Commit a107989

Browse files
authored
Add test case to Issue Template (#986)
* Add test case to Issue Template * Update ---report-an-issue.md
1 parent fe5e21a commit a107989

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

.github/ISSUE_TEMPLATE/---report-an-issue.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ You may also search through existing issues before opening a new one: https://gi
3232

3333
<!--- What is happening instead. --->
3434

35+
### Test Case
36+
37+
To accurately reproduce your issue. Add your test cases [here](https://github.com/parse-community/Parse-SDK-JS/tree/master/integration/test) and read the [Contributing Guide](https://github.com/parse-community/Parse-SDK-JS/blob/master/CONTRIBUTING.md) to run the tests.
38+
3539
### Environment Setup
3640

3741
- **Server**

CONTRIBUTING.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The Parse JS SDK is built for three platforms:
3434
- nodejs
3535
- react-native
3636

37-
When developing the SDK you can use `npm run watch` in order to rebuild your changes upon each saves.
37+
When developing the SDK you can use `npm run watch` in order to rebuild your changes upon each save.
3838

3939
By default, the watch command will rebuild the SDK for the browser platform. The following commands will rebuild changes for a specific platform.
4040

@@ -44,7 +44,7 @@ By default, the watch command will rebuild the SDK for the browser platform. The
4444

4545
### Testing the code
4646

47-
The SDK is tested through two lenses. unit tests are run with jest and integrationt tests with jasmine.
47+
The SDK is tested through two lenses. unit tests are run with jest and integration tests with jasmine.
4848

4949
Two different frameworks are used as the integration tests leverage a stateful server, with the data saved into the database, and Jest is running many tests in parallel, which makes it incompatible with our integration tests.
5050

@@ -54,12 +54,11 @@ Those tests are located in [/src/__tests__](/src/__tests__) and are responsible
5454

5555
To run unit tests, run `npm test`. If you have the vscode Jest plugin extension (as recommended), you can run your tests by clicking the *Debug* lens that appears near by the test.
5656

57-
5857
#### Integration tests
5958

6059
Those tests are located in [/integration/test](/integration/test) and are responsible for ensuring a proper communication with parse-server. With the integration tests, we ensure all communications between the SDK and the server are behaving accordingly.
6160

62-
To run the integtation tests, you will need a valid mongodb running on your local machine. You can get easily mongodb running with `mongodb-runner` (see [Recommended setup](#recommended-setup)).
61+
To run the integration tests, you will need a valid mongodb running on your local machine. You can get easily mongodb running with `mongodb-runner` (see [Recommended setup](#recommended-setup)).
6362

6463
Use `npm run integration` in order to run the integration tests. If you have the vscode Jasmine extension installed (as recommended), you can run your tests by clicking the *Run* or the *Debug* lens that appears near by the test.
6564

0 commit comments

Comments
 (0)