Skip to content

Commit 9d9f78d

Browse files
committed
docs: Delete instructions to run non-existent soundness.sh
Utilities/soundness.sh was deleted in swiftlang#199 which moved CI to GitHub Actions. Credit to @heckj, who found the same problem in apple/swift-container-plugin#96.
1 parent a3e3c73 commit 9d9f78d

File tree

1 file changed

+1
-24
lines changed

1 file changed

+1
-24
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -58,29 +58,6 @@ We require that your commit messages match our template. The easiest way to do t
5858

5959
git config commit.template Utilities/git.commit.template
6060

61-
### Run `./Utilities/soundness.sh`
62-
63-
The scripts directory contains a [`soundness.sh` script](https://github.com/apple/swift-sdk-generator/blob/main/Utilities/soundness.sh)
64-
that enforces additional checks, like license headers and formatting style.
65-
66-
Please make sure to run `./Utilities/soundness.sh` before pushing a change upstream, otherwise it is likely the PR validation will fail
67-
on minor changes such as formatting issues.
68-
69-
For frequent contributors, we recommend adding the script as a [git pre-push hook](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks), which you can do via executing the following command in the project root directory:
70-
71-
```bash
72-
cat << EOF > .git/hooks/pre-push
73-
74-
if [[ -f "Utilities/soundness.sh" ]]; then
75-
Utilities/soundness.sh
76-
fi
77-
EOF
78-
```
79-
80-
Which makes the script execute, and only allow the `git push` to complete if the check has passed.
81-
82-
In the case of formatting issues, you can then `git add` the formatting changes, and attempt the push again.
83-
8461
## How to contribute your work
8562

86-
Please open a pull request at https://github.com/apple/swift-sdk-generator. Make sure the CI passes, and then wait for code review.
63+
Please open a pull request at https://github.com/apple/swift-sdk-generator. Make sure the CI passes, and then wait for code review.

0 commit comments

Comments
 (0)