Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve contribution docs + clean up AndroidManifest.xml #97

Merged
merged 4 commits into from
Nov 14, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,20 @@ If you have a usage question pertaining to the Maplibre Navigation SDK for Andro

If you want to contribute code:

1. Please familiarize yourself with the [install process](https://www.mapbox.com/android-docs/navigation/overview/#install-the-navigation-sdk).
1. Please familiarize yourself with the [install process](README.md).

2. Ensure that existing [pull requests](https://github.com/mapbox/mapbox-navigation-android/pulls) and [issues](https://github.com/mapbox/mapbox-navigation-android/issues) don’t already cover your contribution or question.
2. Ensure that existing [pull requests](https://github.com/maplibre/maplibre-navigation-android/pulls) and [issues](https://github.com/maplibre/maplibre-navigation-android/issues) don’t already cover your contribution or question.

3. Pull requests are gladly accepted. If there are any changes that developers should be aware of, please update the [change log](CHANGELOG.md)

4. Mapbox uses checkstyle to enforce good Java code standards, Make sure to read the [wiki entry](https://github.com/mapbox/mapbox-navigation-android/wiki/Setting-up-Mapbox-checkstyle) and setup. CI will fail if your PR contains any mistakes.
4. ~~We use checkstyle to enforce good coding standards. CI will fail if your PR contains any issues.~~ Lints are currently disabled; PRs welcome to improve the situation. Unit tests still run though!

## Getting started building

You can check out the repo and build locally using Android Studio or the gradle wrapper CLI,
just as with any other Kotlin/Java project.
Do note however that currently the lints fail, so you should run build excluding lints.
For example: `./gradlew build -x lint`.

## Adding or updating a localization

Expand Down
9 changes: 1 addition & 8 deletions libandroid-navigation/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,12 @@

Fabi755 marked this conversation as resolved.
Show resolved Hide resolved
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
Fabi755 marked this conversation as resolved.
Show resolved Hide resolved

<application>
<service
android:name="com.mapbox.services.android.navigation.v5.navigation.NavigationService"
android:foregroundServiceType="location" />
<provider
android:name="com.mapbox.android.telemetry.provider.MapboxTelemetryInitProvider"
android:authorities="${applicationId}.mapboxtelemetryinitprovider"
android:exported="false"
android:initOrder="100"
tools:node="remove" />
<!-- Include the telemetry service to simplify set up (https://www.mapbox.com/telemetry) -->
<service android:name="com.mapbox.services.android.telemetry.service.TelemetryService"/>
</application>

</manifest>
Loading