Skip to content

Commit

Permalink
Add SwiftFormat version instructions to README 📖 (#18)
Browse files Browse the repository at this point in the history
Co-authored-by: Konrad `ktoso` Malawski <ktoso@apple.com>
  • Loading branch information
slashmo and ktoso authored Nov 5, 2020
1 parent 62b0c7f commit a53bd0f
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,9 +280,14 @@ TODO: make a forums category?

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

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

```
``` sh
echo './scripts/sanity.sh' > .git/hooks/pre-push
```

### Formatting

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

0 comments on commit a53bd0f

Please sign in to comment.