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
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -68,30 +68,30 @@ We require that your commit messages match our template. The easiest way to do t
68
68
SwiftServiceLifecycle uses XCTest to run tests on both macOS and Linux. While the macOS version of XCTest is able to use the Objective-C runtime to discover tests at execution time, the Linux version is not.
69
69
For this reason, whenever you add new tests **you have to run a script** that generates the hooks needed to run those tests on Linux, or our CI will complain that the tests are not all present on Linux. To do this, merely execute `ruby ./scripts/generate_linux_tests.rb` at the root of the package and check the changes it made.
70
70
71
-
### Run `./scripts/sanity.sh`
71
+
### Run `./scripts/soundness.sh`
72
72
73
-
The scripts directory contains a [sanity.sh script](scripts/sanity.sh)
73
+
The scripts directory contains a [soundness.sh script](scripts/soundness.sh)
74
74
that enforces additional checks, like license headers and formatting style.
75
-
Please make sure to `./scripts/sanity.sh` before pushing a change upstream, otherwise it is likely the PR validation will fail
75
+
Please make sure to `./scripts/soundness.sh` before pushing a change upstream, otherwise it is likely the PR validation will fail
76
76
on minor changes such as a missing `self.` or similar formatting issues.
77
77
78
78
> The script also executes the above mentioned `generate_linux_tests.rb`.
79
79
80
80
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
81
-
in the project root directory:
81
+
in the project root directory:
82
82
83
83
```bash
84
84
cat <<EOF > .git/hooks/pre-push
85
85
#!/bin/bash
86
86
87
-
if [[ -f "scripts/sanity.sh" ]]; then
88
-
scripts/sanity.sh
87
+
if [[ -f "scripts/soundness.sh" ]]; then
88
+
scripts/soundness.sh
89
89
fi
90
90
EOF
91
91
```
92
92
Which makes the script execute, and only allow the `git push` to complete if the check has passed.
93
93
94
-
In the case of formatting issues, you can then `git add` the formatting changes, and attempt the push again.
94
+
In the case of formatting issues, you can then `git add` the formatting changes, and attempt the push again.
0 commit comments