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
+38-8Lines changed: 38 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -3,24 +3,49 @@ We want to make contributing to this project as easy and transparent as possible
3
3
4
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/ParsePlatform/Parse-SDK-JS/labels/good%20first%20bug). These are simple yet valuable tasks that should be easy to get started.
5
5
6
-
## Pull Requests
7
-
We actively welcome your pull requests.
6
+
## Code of Conduct
7
+
Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](https://code.facebook.com/codeofconduct) so that you can understand what actions will and will not be tolerated.
8
+
9
+
## Our Development Process
10
+
Most of our work will be done in public directly on GitHub. There may be changes done through our internal source control, but it will be rare and only as needed.
11
+
12
+
### `master` is unsafe
13
+
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.
14
+
15
+
### Pull Requests
16
+
We actively welcome your pull requests. When we get one, we'll run some Parse-specific integration tests on it first. From here, we'll need to get a core member to sign off on the changes and then merge the pull request. For API changes we may need to fix internal uses, which could cause some delay. We'll do our best to provide updates and feedback throughout the process.
8
17
9
18
1. Fork the repo and create your branch from `master`.
10
-
2.If you've added code that should be tested, add tests
19
+
2.Add unit tests for any new code you add.
11
20
3. If you've changed APIs, update the documentation.
12
21
4. Ensure the test suite passes.
13
22
5. Make sure your code lints.
14
23
6. If you haven't already, complete the Contributor License Agreement ("CLA").
15
24
16
-
## Contributor License Agreement ("CLA")
25
+
###Contributor License Agreement ("CLA")
17
26
In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Facebook's open source projects.
18
27
19
28
Complete your CLA here: <https://developers.facebook.com/opensource/cla>
20
29
21
-
## Issues
22
-
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
23
30
31
+
## Bugs
32
+
Although we try to keep developing on Parse easy, you still may run into some issues. General questions should be asked on [Google Groups][google-group], technical questions should be asked on [Stack Overflow][stack-overflow], and for everything else we'll be using GitHub issues.
33
+
34
+
### Known Issues
35
+
We use GitHub issues to track public bugs. We will keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new issue, try to make sure your problem doesn't already exist.
36
+
37
+
### Reporting New Issues
38
+
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].
39
+
40
+
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:
41
+
42
+
* A description. What did you expect to happen and what actually happened? Why do you think that was wrong?
43
+
* A simple unit test that fails. Refer [here][tests-dir] for examples of existing unit tests. See our [README](README.md#usage) for how to run unit tests. You can submit a pull request with your failing unit test so that our CI verifies that the test fails.
44
+
* What version does this reproduce on? What version did it last work on?
45
+
*[Stacktrace or GTFO][stacktrace-or-gtfo]. In all honesty, full stacktraces with line numbers make a happy developer.
46
+
* Anything else you find relevant.
47
+
48
+
### Security Bugs
24
49
Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.
25
50
26
51
## Coding Style
@@ -32,5 +57,10 @@ Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
32
57
## License
33
58
By contributing to the Parse JavaScript SDK, you agree that your contributions will be licensed under its license.
34
59
35
-
## Code of Conduct
36
-
Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](https://code.facebook.com/codeofconduct) so that you can understand what actions will and will not be tolerated.
0 commit comments