Skip to content

Commit 16294a2

Browse files
committed
Add information about pre-PR check script to CONTRIBUTING.md document
1 parent 863f261 commit 16294a2

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,17 @@ Alternatively, you can generate the files from the command line by running the f
5252
swift run --package-path CodeGeneration
5353
```
5454
55+
## Running Pre-PR Checks Script
56+
57+
To ensure that your changes to the project are implemented correctly and do not introduce issues across the repository, a script has been provided to automate the necessary pre-PR checks.
58+
59+
```bash
60+
swift run --package-path SwiftSyntaxDevUtils/ swift-syntax-dev-utils local-pr-precheck
61+
```
62+
63+
> [!NOTE]
64+
> Running the pre-PR checks script may take some time, so it's recommended to perform this final check before submitting a PR rather than after every change.
65+
5566
## Authoring commits
5667

5768
Prefer to squash the commits of your PR (*pull request*) and avoid adding commits like “Address review comments”. This creates a clearer git history, which doesn’t need to record the history of how the PR evolved.

0 commit comments

Comments
 (0)