You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+2-24Lines changed: 2 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -54,29 +54,7 @@ A good patch is:
54
54
3. Documented, adding API documentation as needed to cover new functions and properties.
55
55
4. Accompanied by a great commit message, using our commit message template.
56
56
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
-
80
57
## How to contribute your work
81
58
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