Skip to content

Update CONTRIBUTING.md #844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 27, 2022
Merged

Update CONTRIBUTING.md #844

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d190198
Update CONTRIBUTING.MD
ibrahimoktay Sep 26, 2022
88f6ec6
Add swift-argument-parser
ibrahimoktay Sep 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ Since SwiftSyntax relies on definitions in the main Swift repository to generate

To build the `main` branch of SwiftSyntax, follow the following instructions:

1. Check `swift-syntax` and `swift` out side by side:
1. Check `swift-syntax`, `swift-argument-parser` and `swift` out side by side:
```
- (enclosing directory)
- swift
- swift-argument-parser
- swift-syntax
```

Expand All @@ -30,8 +31,6 @@ To build the `main` branch of SwiftSyntax, follow the following instructions:

Swift-CI will automatically run the code generation step whenever a new toolchain (development snapshot or release) is published. It should thus almost never be necessary to perform the above build yourself.

Afterward, SwiftPM can also generate an Xcode project to develop SwiftSyntax by running `swift package generate-xcodeproj`.

If you also want to run tests locally, read the section below as testing has additional requirements.

## Local Testing
Expand Down