Skip to content

Commit 9fbe204

Browse files
committed
refactor compatibility
1 parent 6727da7 commit 9fbe204

File tree

2 files changed

+20
-30
lines changed

2 files changed

+20
-30
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,7 @@
11
# Contributing to Parse SDK for Android
22
We want to make contributing to this project as easy and transparent as possible.
33

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
115
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.
126

137
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
1610
4. Ensure the test suite passes.
1711
5. Make sure your code lints by running `./gradlew spotlessApply`.
1812

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
2114

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.
2418

25-
### Reporting New Issues
19+
## Reporting an Issue
2620
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].
2721

2822
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
4135
## License
4236
By contributing to Parse Android SDK, you agree that your contributions will be licensed under its license.
4337

44-
[stack-overflow]: http://stackoverflow.com/tags/parse.com
45-
[bug-reports]: https://github.com/parse-community/parse-server
46-
[rest-api]: http://docs.parseplatform.org/rest/guide/
47-
[network-debugging-tool]: https://github.com/square/okhttp/wiki/Interceptors
48-
[parse-api-console]: http://blog.parseplatform.org/announcements/introducing-the-parse-api-console/
49-
[stacktrace-or-gtfo]: http://i.imgur.com/jacoj.jpg
50-
[tests-dir]: /parse/src/test/java/com/parse
38+
[stack-overflow]: http://stackoverflow.com/tags/parse.com
39+
[bug-reports]: https://github.com/parse-community/parse-server
40+
[rest-api]: http://docs.parseplatform.org/rest/guide/
41+
[network-debugging-tool]: https://github.com/square/okhttp/wiki/Interceptors
42+
[parse-api-console]: http://blog.parseplatform.org/announcements/introducing-the-parse-api-console/
43+
[stacktrace-or-gtfo]: http://i.imgur.com/jacoj.jpg
44+
[tests-dir]: /parse/src/test/java/com/parse

README.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,18 +35,13 @@ A library that gives you access to the powerful Parse Server backend from your A
3535

3636
## Compatibility
3737

38-
The Android API versions compatibility is defined as follow:
38+
The Parse Android SDK has the following Android API and [Gradle Plugin][gradle-plugin] compatibility.
3939

40-
- Target API level - Try awlays to target the latest available stable one
41-
- Minimum API level - Bump to API 21 starting from 2.1.0 and increment as high as possible, but cover at least 95% of devices. The increment will be done only if some of the dependent libraries requires it or if the statistics points that this API level covers at least 95% of the devices. All API changes will be marked in the release notes.
42-
43-
| SDK version | Minimum API level | Targeting API level | AGP[^1] |
44-
| ----------- | ----------------- | ------------------- | ------- |
45-
| 1.26 | < API 16 | API 29 | 3.6.2 |
46-
| 2.0 | >= API 16 | API 30 | 4.2.2 |
47-
| 2.1+ | >= API 21 | API 31 | 7.0.3 |
48-
49-
[^1]: AGP stand for [Android Gradle Plugin](https://developer.android.com/studio/releases/gradle-plugin)
40+
| SDK version | Minimum API level | Targeting API level | Gradle Plugin |
41+
|-------------|-------------------|---------------------|---------------|
42+
| 1.26 | < API 16 | API 29 | 3.6.2 |
43+
| 2.0 | >= API 16 | API 30 | 4.2.2 |
44+
| 2.1 | >= API 21 | API 31 | 7.0.3 |
5045

5146
## Add Dependency
5247

@@ -150,3 +145,4 @@ As of April 5, 2017, Parse, LLC has transferred this code to the parse-community
150145

151146
[guide]: http://docs.parseplatform.org/android/guide/
152147
[open-collective-link]: https://opencollective.com/parse-server
148+
[gradle-plugin]: https://developer.android.com/studio/releases/gradle-plugin

0 commit comments

Comments
 (0)