[Documentation] Add note in CONTRIBUTING.md about SwiftPM-Package
#5732
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ncooke3
requested review from
abertelrud,
neonichu,
tomerd and
elsh
as code owners
|
@swift-ci please smoke test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add clarification to CONTRIBUTING.md that emphasizes the need to run the
SwiftPM-Packagescheme before building other schemes.Motivation:
I ran into the
no such module 'PackageDescription'error when trying to debug something in Swift Package Manager. I filed #5705 and @neonichu clarified that theSwiftPM-Packagescheme should be built first before building other schemes. Reason being that theSwiftPM-Packagescheme builds thePackageDescriptionlibrary. I wanted to add a note in the CONTRIBUTING.md to clarify this for future readers.Modifications:
Added a note to the
Using Xcode (Easiest)section that clarifies the importance of first running theSwiftPM-Packagescheme. This is a documentation only change.Result:
Contributors will understand that need to run the
SwiftPM-Packagescheme to avoid theno such module 'PackageDescription'error.