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
We want to make contributing to this project as easy and transparent as possible.
3
3
4
-
## Our Development Process
5
-
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.
6
-
7
-
### `master` is unsafe
8
-
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.
9
-
10
-
### Pull Requests
4
+
## Pull Requests
11
5
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.
12
6
13
7
1. Fork the repo and create your branch from `master`.
@@ -16,13 +10,13 @@ We actively welcome your pull requests. When we get one, we'll run some Parse-sp
16
10
4. Ensure the test suite passes.
17
11
5. Make sure your code lints by running `./gradlew spotlessApply`.
18
12
19
-
## Bugs
20
-
Although we try to keep developing on Parse easy, you still may run into some issues. Technical questions should be asked on [Stack Overflow][stack-overflow], and for everything else we'll be using GitHub issues.
13
+
## Android API compatibility
21
14
22
-
### Known Issues
23
-
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.
15
+
Consider the following to ensure a consistent Android API compatibility for the Parse Android SDK:
16
+
- Target API level: Target the latest available stable API version.
17
+
- Minimum API level: Cover at least ~90% of devices. The increment will be done only if dependencies requires it, if the statistics points that the API level covers at least ~90% of devices, or if a currently supported Android API level does not receive security updates anymore. Minimum API level changes must be marked in the release notes as breaking changes.
24
18
25
-
###Reporting New Issues
19
+
## Reporting an Issue
26
20
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].
27
21
28
22
To view the REST API network requests issued by the Parse SDK and responses from the Parse backend, please check out [OkHttp Interceptors][network-debugging-tool]. With this tool, you can either log network requests/responses to Android logcat, or log them to Chrome Debugger via Stetho.
@@ -41,10 +35,10 @@ This project adheres to the [Contributor Covenant Code of Conduct](https://githu
41
35
## License
42
36
By contributing to Parse Android SDK, you agree that your contributions will be licensed under its license.
Add this in your root `build.gradle` file (**not** your module `build.gradle` file):
@@ -46,6 +57,7 @@ allprojects {
46
57
```
47
58
48
59
Then, add the library to your project `build.gradle`
60
+
49
61
```gradle
50
62
ext {
51
63
parseVersion = "latest.version.here"
@@ -104,6 +116,7 @@ The custom `Application` class must be registered in `AndroidManifest.xml`:
104
116
...
105
117
</application>
106
118
```
119
+
107
120
Note that if you are testing with a server using `http`, you will need to add `android:usesCleartextTraffic="true"` to your above `<application>` definition, but you should only do this while testing and should use `https` for your final product.
108
121
109
122
See the [guide][guide] for the rest of the SDK usage.
@@ -113,6 +126,7 @@ See the [guide][guide] for the rest of the SDK usage.
113
126
We want to make contributing to this project as easy and transparent as possible. Please refer to the [Contribution Guidelines](CONTRIBUTING.md).
114
127
115
128
# More Parse Android Projects
129
+
116
130
These are other official libraries we made that can help you create your Parse app.
117
131
118
132
-[ParseGoogleUtils](/google) - Google login/signup.
@@ -131,3 +145,4 @@ As of April 5, 2017, Parse, LLC has transferred this code to the parse-community
0 commit comments