Skip to content

Commit fd0c521

Browse files
authored
Remove soundness.sh script instructions from CONTRIBUTING.md (#110)
Removed instructions for running the soundness.sh script and adding it as a git pre-push hook as the script does not exist anymore.
1 parent dae012b commit fd0c521

File tree

1 file changed

+0
-26
lines changed

1 file changed

+0
-26
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -54,32 +54,6 @@ A good patch is:
5454
3. Documented, adding API documentation as needed to cover new functions and properties.
5555
4. Accompanied by a great commit message, using our commit message template.
5656

57-
### Run `./scripts/soundness.sh`
58-
59-
The scripts directory contains a [soundness.sh script](https://github.com/apple/swift-http-types/blob/main/scripts/soundness.sh)
60-
that enforces additional checks, like license headers and formatting style.
61-
62-
Please make sure to `./scripts/soundness.sh` before pushing a change upstream, otherwise it is likely the PR validation will fail
63-
on minor changes such as a missing `self.` or similar formatting issues.
64-
65-
> The script also executes the above mentioned `generate_linux_tests.rb`.
66-
67-
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:
68-
69-
```sh
70-
cat << EOF > .git/hooks/pre-push
71-
#!/bin/sh
72-
73-
if [ -f "scripts/soundness.sh" ]; then
74-
scripts/soundness.sh
75-
fi
76-
EOF
77-
```
78-
79-
Which makes the script execute, and only allow the `git push` to complete if the check has passed.
80-
81-
In the case of formatting issues, you can then `git add` the formatting changes, and attempt the push again.
82-
8357
## How to contribute your work
8458

8559
Please open a pull request at https://github.com/apple/swift-http-types. Make sure the CI passes, and then wait for code review.

0 commit comments

Comments
 (0)