-
-
Notifications
You must be signed in to change notification settings - Fork 69
Add basic documentation #10
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
Conversation
@Tom-Fox1 Thank you for contributing. Who is maintain parse-swift repo? We need to update the contributing guide. |
There are no maintainer for this repo. New maintainers are welcome |
@TomWFox I think we can add some of the usage/testing from #12 (comment), particularly the playgrounds part. The project can be imported via SPM, Cocoapods, Carthage (I've never use this before, but the tests pass) by linking to the repo link directly |
For the Contributing guide, we can add, |
@cbaker6 @pranjalsatija I think this is good to go now. The details in the contributing doc are very basic right now but at some point I'll add info about setting up a Parse Server locally to test etc. Btw I haven't actually tried the SPM or Carthage install but I think they should both work. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, other than the one nit!
Before we merge, I'm going to try and install this via SPM or CocoaPods and make sure it works. I'll be able to do that later tonight.
@TomWFox lgtm! I'm not sure if you should add the SwiftLint line I mentioned directly in the doc. If people don't install it locally, they may write a bunch of code that has SwiftLint errors that won't be detected until they make a PR for travis to catch. Installing it locally allows them to see errors and warnings on the fly |
@TomWFox just confirming that I was able to install ParseSwift, then build and launch a blank iOS single view app template using SPM and CocoaPods with no issues. |
@cbaker6 good point, added |
@pranjalsatija thanks for checking, only Carthage that is untested now (by us anyway). |
I just tested that out too (just to be safe), it worked. |
Great! |
Uh oh!
There was an error while loading. Please reload this page.