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
+8Lines changed: 8 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,11 @@
1
1
# Contributing to the Parse JavaScript SDK
2
+
2
3
We want to make contributing to this project as easy and transparent as possible.
3
4
4
5
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
6
6
7
## `master` is unsafe
8
+
7
9
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.
8
10
9
11
## Setting up the project for debugging and contributing:
@@ -63,6 +65,7 @@ To run the integration tests, you will need a valid mongodb running on your loca
63
65
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.
64
66
65
67
### Pull Requests
68
+
66
69
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.
67
70
68
71
1. Fork the repo and create your branch from `master`.
@@ -72,9 +75,11 @@ We actively welcome your pull requests. When we get one, we'll run some Parse-sp
72
75
5. Make sure your code lints.
73
76
74
77
### Known Issues
78
+
75
79
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.
76
80
77
81
### Reporting New Issues
82
+
78
83
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].
79
84
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.
80
85
@@ -87,9 +92,11 @@ Details are key. The more information you provide us the easier it'll be for us
87
92
* Anything else you find relevant.
88
93
89
94
### Security Bugs
95
+
90
96
Parse Community has a [responsible Vulnerability Disclosure Program](https://github.com/parse-community/parse-server/blob/master/SECURITY.md) 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.
91
97
92
98
## Coding Style
99
+
93
100
* Most importantly, match the existing code style as much as possible.
94
101
* We use [Flow](http://flowtype.org/) and ES6 for this codebase. Use modern syntax whenever possible.
95
102
* Keep lines within 80 characters.
@@ -100,6 +107,7 @@ Parse Community has a [responsible Vulnerability Disclosure Program](https://git
100
107
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.
101
108
102
109
## License
110
+
103
111
By contributing to the Parse JavaScript SDK, you agree that your contributions will be licensed under its license.
0 commit comments