Skip to content

Commit 7229c3a

Browse files
authored
docs: Update CONTRIBUTING to reference soundness checks and remove advice to run locally (#97)
### Motivation scripts/soundness.sh was deleted in #5 which moved CI to GitHub Actions. resolves #96 ### Modifications Remove the instruction to run `scripts/soundness.sh` from `CONTRIBUTING.md`. ### Result Documentation no longer refers to nonexistent scripts. ### Test Plan No functional change.
1 parent 328ef68 commit 7229c3a

File tree

1 file changed

+2
-24
lines changed

1 file changed

+2
-24
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -54,29 +54,7 @@ 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-container-plugin/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-
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:
66-
67-
```bash
68-
cat << EOF > .git/hooks/pre-push
69-
70-
if [[ -f "scripts/soundness.sh" ]]; then
71-
scripts/soundness.sh
72-
fi
73-
EOF
74-
```
75-
76-
Which makes the script execute, and only allow the `git push` to complete if the check has passed.
77-
78-
In the case of formatting issues, you can then `git add` the formatting changes, and attempt the push again.
79-
8057
## How to contribute your work
8158

82-
Please open a pull request at https://github.com/apple/swift-container-plugin. Make sure the CI passes, and then wait for code review.
59+
Please open a pull request at https://github.com/apple/swift-container-plugin.
60+
Continuous integration (CI) checks for required content (headers), runs a variety of tests, and verifies the documentation builds. All pull requests should pass CI checks before a code review.

0 commit comments

Comments
 (0)