Skip to content

Commit

Permalink
Fix broken swift format link (#2948)
Browse files Browse the repository at this point in the history
Trying to fix swift format link in contributions.md

Someone please let me know what the process is for running `swift
format` locally now that the script has been moved out of the repo.

Co-authored-by: Franz Busch <[email protected]>
  • Loading branch information
ali-ahsan-ali and FranzBusch authored Oct 31, 2024
1 parent de116b7 commit 08af85a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Try to keep your lines less than 120 characters long so github can correctly dis

SwiftNIO uses the [swift-format](https://github.com/swiftlang/swift-format) tool to bring consistency to code formatting. There is a specific [.swift-format](./.swift-format) configuration file. This will be checked and enforced on PRs. Note that the check will run on the current most recent stable version target which may not match that in your own local development environment.

If you want to apply the formatting to your local repo before you commit then you can either run [check-swift-format.sh](./scripts/check-swift-format.sh) which will use your current toolchain, or to match the CI checks exactly you can use `act` (see [act section](#act)):
If you want to apply the formatting to your local repo before you commit then you can either run [check-swift-format.sh](https://github.com/swiftlang/github-workflows/blob/main/.github/workflows/scripts/check-swift-format.sh) which will use your current toolchain, or to match the CI checks exactly you can use `act` (see [act section](#act)):
```
act --action-offline-mode --bind workflow_call -j format-check --input format_check_enabled=true
```
Expand Down

0 comments on commit 08af85a

Please sign in to comment.