If you have a usage question pertaining to the Mapbox Navigation SDK for Android, or any of our other products, contact us through our support page.
If you want to contribute code:
-
Please familiarize yourself with the install process.
-
Ensure that existing pull requests and issues don’t already cover your contribution or question.
-
Pull requests are gladly accepted. If there are any changes that developers should be aware of, please update the change log
-
Mapbox uses checkstyle to enforce good Java code standards, Make sure to read the wiki entry and setup. CI will fail if your PR contains any mistakes.
The Mapbox Navigation SDK for Android features several translations contributed through Transifex. If your language already has a translation, feel free to complete or proofread it. Otherwise, please request your language so you can start translating. Note that we’re primarily interested in languages that Android supports as system languages.
While you’re there, please consider also translating the following related projects:
- OSRM Text Instructions, which the Mapbox Directions API uses to generate textual and verbal turn instructions (instructions)
- Mapbox Navigation SDK for iOS, the analogous library for iOS applications (instructions)
- Mapbox Maps SDK for Android, which is responsible for the map view and minor UI elements such as the Mapbox Telemetry permissions dialog
Once you’ve finished translating the Android navigation SDK into a new language in Transifex, open an issue in this repository asking to pull in your localization. Or do it yourself:
- (First time only.) Download the
tx
command line tool and configure your .transifexrc. - Run
tx pull -a
to fetch translations from Transifex. You can restrict the operation to just the new language usingtx pull -l xyz
, where xyz is the language code. - Commit any new files that were added and open a pull request with your changes.
Everyone is invited to participate in Mapbox’s open source projects and public discussions: we want to create a welcoming and friendly environment. Harassment of participants or other unethical and unprofessional behavior will not be tolerated in our spaces. The Contributor Covenant applies to all projects under the Mapbox organization and we ask that you please read the full text.
You can learn more about our open source philosophy on mapbox.com.