Skip to content

Latest commit

 

History

History
35 lines (20 loc) · 3.54 KB

CONTRIBUTING.md

File metadata and controls

35 lines (20 loc) · 3.54 KB

Contributing

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:

  1. Please familiarize yourself with the install process.

  2. Ensure that existing pull requests and 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

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

Adding or updating a localization

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:

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:

  1. (First time only.) Download the tx command line tool and configure your .transifexrc.
  2. Run tx pull -a to fetch translations from Transifex. You can restrict the operation to just the new language using tx pull -l xyz, where xyz is the language code.
  3. Commit any new files that were added and open a pull request with your changes.

Code of conduct

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.