Skip to content

Commit

Permalink
update contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
Patrick-Kladek committed Apr 15, 2024
1 parent ba33a72 commit dfe6d14
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,7 @@ When reporting a bug in the navigation SDK itself, please indicate:

## Building the SDK

To build this SDK, you need Xcode 15 and [Carthage](https://github.com/Carthage/Carthage/):

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

See [the README](./README.md#running-the-example-project) for instructions on building and running the included Swift and Objective-C example projects.
To build this SDK, you need Xcode 15. Simply open Package.swift, it will open in Xcode and download all required dependencies.

## Enable automatic code formatting

Expand All @@ -32,7 +27,7 @@ git config core.hooksPath .githooks

## Testing the SDK

It is important to test the SDK using the `iPhone 8 Plus` simulator for the `FBSnapshotter` tests.
You can run tests locally in Xcode. As a safety measure tests are run via GitHub Actions when you submitt a PR. If you are a first time contributor a member of maplibre needs to approve the GitHub Actions runs first, for this please tag someone either in GitHub or in the OpenStreetMap Slack.

## Opening a pull request

Expand Down

0 comments on commit dfe6d14

Please sign in to comment.