swiftlang / swift

The Swift Programming Language
https://swift.org
Apache License 2.0
67.57k stars 10.35k forks source link

Update CONTRIBUTING.md to include PR process / forking information #72674

Open adammcarter opened 7 months ago

adammcarter commented 7 months ago

Motivation

Hi all, when making my first contribution to Swift Syntax (🎉) it wasn't quite clear on the process to create PRs within this repo - see the comment from here: https://github.com/apple/swift-syntax/issues/1936#issuecomment-2025867752 onwards in that thread.

Proposed solution

From that conversation it was suggested to open an issue to update the CONTRIBUTING.md both in Swift Syntax and here in the Swift repo to include the steps for non-maintainers to open their very own PRs.

The information on this post: https://github.com/apple/swift-syntax/issues/1936#issuecomment-2025880317 from @Matejkob was super useful and would be good enough to copy and paste in to the CONTRIBUTING.md for any future travellers too IMO.

Thanks in advance!

Alternatives considered

No response

Additional information

No response

adammcarter commented 7 months ago

For the sake of alignment and any stepping on toes, it's likely this PR won't be implemented by me until the Swift Syntax equivalent is done where presumably both will have the same content.

The WIP PR for Swift Syntax is here: https://github.com/apple/swift-syntax/pull/2577