update contributing

maplibre · Apr 12, 2024 · c041a85 · c041a85
1 parent 001bbb7
commit c041a85
Showing 1 changed file with 9 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -15,13 +15,21 @@ When reporting a bug in the navigation SDK itself, please indicate:
 
 ## Building the SDK
 
-To build this SDK, you need Xcode 14 and [Carthage](https://github.com/Carthage/Carthage/):
+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.
 
+## Enable automatic code formatting
+
+We use SwiftFormat via a commit hook which allows us to reformat the changed files on commit. This ensures a conistent code style. The repo is prepared for this, however you need to enable this manually via:
+
+```bash
+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.