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
+25-14Lines changed: 25 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,29 +58,40 @@ A good patch is:
58
58
3. Documented, adding API documentation as needed to cover new functions and properties.
59
59
4. Accompanied by a great commit message, using our commit message template.
60
60
61
-
### Run `./scripts/soundness.sh`
61
+
##Running CI workflows locally
62
62
63
-
The scripts directory contains a [soundness.sh script](https://github.com/apple/swift-openapi-urlsession/blob/main/scripts/soundness.sh)
64
-
that enforces additional checks, like license headers and formatting style.
63
+
You can run the Github Actions workflows locally using
64
+
[act](https://github.com/nektos/act). To run all the jobs that run on a pull
65
+
request, use the following command:
65
66
66
-
Please make sure to `./scripts/soundness.sh` before pushing a change upstream, otherwise it is likely the PR validation will fail
67
-
on minor changes such as a missing `self.` or similar formatting issues.
67
+
```bash
68
+
% act pull_request
69
+
```
68
70
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:
71
+
To run just a single job, use `workflow_call -j <job>`, and specify the inputs
72
+
the job expects. For example, to run just shellcheck:
0 commit comments