Skip to content

Commit a53bd0f

Browse files
slashmoktoso
andauthored
Add SwiftFormat version instructions to README 📖 (#18)
Co-authored-by: Konrad `ktoso` Malawski <[email protected]>
1 parent 62b0c7f commit a53bd0f

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -280,9 +280,14 @@ TODO: make a forums category?
280280

281281
Please make sure to run the `./scripts/sanity.sh` script when contributing, it checks formatting and similar things.
282282

283-
You can make ensure it always is run and passes before you push by installing a pre-push hook with git:
283+
You can ensure it always is run and passes before you push by installing a pre-push hook with git:
284284

285-
```
285+
``` sh
286286
echo './scripts/sanity.sh' > .git/hooks/pre-push
287287
```
288288

289+
### Formatting
290+
291+
We use a specific version of [`nicklockwood/swiftformat`](https://github.com/nicklockwood/swiftformat).
292+
Please take a look at our [`Dockerfile`](docker/Dockerfile) to see which version is currently being used and install it
293+
on your machine before running the script.

0 commit comments

Comments
 (0)