Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 7.03 KB

CONTRIBUTING.md

File metadata and controls

73 lines (50 loc) · 7.03 KB
Raw

Contributing to the Mapbox Navigation SDK for iOS

Reporting an issue

Bug reports and feature requests are more than welcome, but please consider the following tips so we can respond to your feedback more effectively.

Before reporting a bug here, please determine whether the issue lies with the navigation SDK itself or with another Mapbox product:

When reporting a bug in the navigation SDK itself, please indicate:

  • The navigation SDK version
  • Whether you installed the SDK using CocoaPods or Carthage
  • The iOS version, iPhone model, and Xcode version, as applicable
  • Any relevant language settings

Building the SDK

To build this SDK, you need Xcode 9 and Carthage v0.19.0 or above:

  1. Run carthage bootstrap --platform iOS --cache-builds.
  2. Once the Carthage build finishes, open MapboxNavigation.xcodeproj in Xcode and build the MapboxNavigation scheme.

See the README for instructions on building and running the included Swift and Objective-C example projects.

Making any symbol public

To add any type, constant, or member to the SDK’s public interface:

  1. Ensure that the symbol bridges to Objective-C and does not rely on any language features specific to Swift – so no namespaced types or classes named with emoji! 🙃
  2. Name the symbol according to Swift design guidelines and Cocoa naming conventions.
  3. Use @objc(…) to specify an Objective-C-specific name that conforms to Objective-C naming conventions. Use the MB class prefix to avoid conflicts with client code.
  4. Provide full documentation comments. We use jazzy to produce the documentation found on the website for this SDK. Many developers also rely on Xcode’s Quick Help feature, which supports a subset of Markdown.
  5. (Optional.) Add the type or constant’s name to the relevant category in the custom_categories section of the jazzy configuration file. This is required for classes and protocols and also recommended for any other type that is strongly associated with a particular class or protocol. If you leave out this step, the symbol will appear in an “Other” section in the generated HTML documentation’s table of contents.

Adding user-facing text

To add or update text that the user may see in the navigation SDK:

  1. Use the NSLocalizedString(_:tableName:bundle:value:comment:) method: 
    NSLocalizedString("UNIQUE_IDENTIFIER", bundle: .mapboxNavigation, value: "What English speakers see", comment: "Where this text appears or how it is used")
  2. (Optional.) If you need to embed some text in a string, use NSLocalizedString(_:tableName:bundle:value:comment:) with String.localizedStringWithFormat(_:_:) instead of String(format:): 
    String.localizedStringWithFormat(NSLocalizedString("UNIQUE_IDENTIFIER", bundle: .mapboxNavigation, value: "What English speakers see with %@ for each embedded string", comment: "Format string for a string with an embedded string; 1 = the first embedded string"), embeddedString)
  3. (Optional.) When dealing with a number followed by a pluralized word, do not split the string. Instead, use a format string and make val ambiguous, like %d file(s). Then pluralize for English in the appropriate .stringsdict file. See platform/darwin/resources/en.lproj/Foundation.stringsdict in the Mapbox Maps SDK for an example. Localizers should do likewise for their languages.
  4. Run scripts/extract_localizable.sh to add the new text to the .strings files.
  5. Open a pull request with your changes. Once the pull request is merged, Transifex will pick up the changes within a few hours.

Adding or updating a localization

The Mapbox Navigation SDK for iOS 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. Note that we’re primarily interested in languages that iOS supports as system languages.

While you’re there, consider also translating the Mapbox Maps SDK for iOS, which the navigation SDK depends on, and OSRM Text Instructions, which builds a list of textual and verbal instructions along the route. You can also help translate the Mapbox Navigation SDK for Android.

Once you’ve finished translating the navigation SDK into a new language in Transifex, perform these steps to make Xcode aware of the translation:

  1. (First time only.) Download the tx command line tool and configure your .transifexrc.
  2. In MapboxNavigation.xcodeproj, open the project editor. Using the project editor’s sidebar or tab bar dropdown, go to the “MapboxNavigation” project. Under the Localizations section of the Info tab, click the + button to add your language to the project.
  3. In the sheet that appears, select all the files, then click Finish.

The .strings files should still be in the original English – that’s expected. Now you can pull your translations into this repository:

  1. Run tx pull -a to fetch translations from Transifex.
  2. To facilitate diffing and merging, convert any added .strings files from UTF-16 encoding to UTF-8 encoding. You can convert the file encoding using Xcode’s File inspector or by running scripts/convert_string_files.sh.
  3. If you’ve translated the “localizableabbreviations” resource, change to the scripts/abbreviations/ folder and run ./main import xyz, where xyz is the language code.
  4. For each of the localizable files in the project, open the file, then, in the File inspector, check the box for your new localization.