You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-3Lines changed: 4 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
# Contributing to the Parse JavaScript SDK
2
2
We want to make contributing to this project as easy and transparent as possible.
3
3
4
-
If you're looking to get started, but want to ease yourself into the codebase, look for issues tagged [good first bug](https://github.com/parse-community/Parse-SDK-JS/labels/good%20first%20bug). These are simple yet valuable tasks that should be easy to get started.
4
+
If you're looking to get started, but want to ease yourself into the codebase, look for issues tagged [good first task](https://github.com/parse-community/Parse-SDK-JS/labels/good%20first%20task). These are simple yet valuable tasks that should be easy to get started.
5
5
6
6
## `master` is unsafe
7
7
Our goal is to keep `master` stable, but there may be changes that your application may not be compatible with. We'll do our best to publicize any breaking changes, but try to use our specific releases in any production environment.
@@ -11,7 +11,7 @@ Our goal is to keep `master` stable, but there may be changes that your applicat
11
11
### Recommended setup:
12
12
13
13
*[vscode](https://code.visualstudio.com), the popular IDE.
14
-
*[Jest Extesnsion](https://marketplace.visualstudio.com/items?itemName=Orta.vscode-jest) the Jest extension for vscode to run the tests inline and debug quicky.
14
+
*[Jest Extension](https://marketplace.visualstudio.com/items?itemName=Orta.vscode-jest) the Jest extension for vscode to run the tests inline and debug quicky.
15
15
*[Jasmine Test Explorer Extension](https://marketplace.visualstudio.com/items?itemName=hbenl.vscode-test-explorer), a very practical test exploration plugin which let you run, debug and see the test results inline.
16
16
*[mongodb-runner](https://github.com/mongodb-js/runner) Easily install and run MongoDB to test your code against it. (install with `npm install -g mongodb-runner`)
17
17
@@ -61,11 +61,12 @@ We use GitHub issues to track public bugs. We will keep a close eye on this and
61
61
62
62
### Reporting New Issues
63
63
Not all issues are SDK issues. If you're unsure whether your bug is with the SDK or backend, you can test to see if it reproduces with our [REST API][rest-api] and [Parse API Console][parse-api-console]. If it does, you can report backend bugs [here][bug-reports].
64
+
If the issue only reproduces with the JS SDK, you can [open an issue](https://github.com/parse-community/parse-server/issues) on this repository.
64
65
65
66
Details are key. The more information you provide us the easier it'll be for us to debug and the faster you'll receive a fix. Some examples of useful tidbits:
66
67
67
68
* A description. What did you expect to happen and what actually happened? Why do you think that was wrong?
68
-
* A simple unit test that fails. Refer [here][tests-dir] for examples of existing unit tests and [here](integration-test-dir) for integration tests examples. See for how to setup your machine and run unit tests in [this]() guide. You can submit a pull request with your failing unit test so that our CI verifies that the test fails.
69
+
* A simple unit test that fails. Refer [here][tests-dir] for examples of existing unit tests and [here][integration-test-dir] for integration tests examples. See for how to setup your machine and run unit tests in [this](#setting-up-the-project-for-debugging-and-contributing) guide. You can submit a pull request with your failing unit test so that our CI verifies that the test fails.
69
70
* What version does this reproduce on? What version did it last work on?
70
71
*[Stacktrace or GTFO][stacktrace-or-gtfo]. In all honesty, full stacktraces with line numbers make a happy developer.
0 commit comments