Skip to content

Add Contributing.md #2978

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.

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 10 commits into from
Nov 10, 2020
Merged

Conversation

federicobucchi
Copy link
Member

@federicobucchi federicobucchi commented Oct 12, 2020

rdar://problem/70187482

I made a document for quick start contributions for Swift Package Manager that would be great to add and update with time. Initially we could keep Development.md, but at some point we could switch all the way to Contributing.md having 2 “Quick Start” and “Advanced” sections.

First Step (in this PR):

  1. Add document Contributing.md and add it under /Documentation
  2. Replace the link for contributing on https://github.com/apple/swift-package-manager#contributions to point to the new Contributing.md

Following Step (future PR):
3) Work on consolidating between Contributing.md and the content in https://github.com/apple/swift-package-manager/blob/main/Documentation/Development.md
4) Remove Development.md

@federicobucchi federicobucchi changed the title rdar://problem/70187482 Add Contributing.md Oct 12, 2020
@federicobucchi federicobucchi force-pushed the fb/add-contributing-md branch 3 times, most recently from 1f23267 to 1748933 Compare October 12, 2020 04:39
@abertelrud abertelrud assigned abertelrud and tomerd and unassigned abertelrud Oct 12, 2020
@federicobucchi federicobucchi force-pushed the fb/add-contributing-md branch 4 times, most recently from a7665f4 to db38cc7 Compare October 14, 2020 04:50
@federicobucchi
Copy link
Member Author

@swift-ci please smoke test

Copy link
Contributor

@tomerd tomerd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @federicobucchi, some suggestions

@federicobucchi federicobucchi force-pushed the fb/add-contributing-md branch 2 times, most recently from ee6d243 to e7a6b1f Compare October 17, 2020 03:43
@federicobucchi
Copy link
Member Author

@swift-ci please smoke test

@federicobucchi federicobucchi requested a review from tomerd October 20, 2020 03:51
@federicobucchi
Copy link
Member Author

@swift-ci please smoke test

@federicobucchi
Copy link
Member Author

@swift-ci please smoke test

@federicobucchi federicobucchi requested a review from tomerd November 7, 2020 17:45
@tomerd
Copy link
Contributor

tomerd commented Nov 9, 2020

@swift-ci please smoke test

@tomerd tomerd merged commit c10c9b8 into swiftlang:main Nov 10, 2020
@tomerd
Copy link
Contributor

tomerd commented Nov 10, 2020

thank you @federicobucchi

federicobucchi added a commit to federicobucchi/swift-package-manager that referenced this pull request Jan 6, 2021
motivation: Quick start contribution guide for Swift Package Manager.

Changes:
* Add Documentation/Contributing.md
* Add SwiftFormat and patch size / number of commits info
* Add ISSUE_TEMPLATE.md and PULL_REQUEST_TEMPLATE.md
* Consolidate between Contributing.md and the content in https://github.com/apple/swift-package-
manager/blob/main/Documentation/Development.md and remove Development.md
* Update Contributions section in main README.md
* Replace the link for contributing on https://github.com/apple/swift-package-manager#contributions to point to the new Contributing.md

rdar://problem/70187482
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants