search

matteocrippa / awesome-swift

A collaborative list of awesome Swift libraries and resources. Feel free to contribute!
Creative Commons Zero v1.0 Universal
24.75k stars 3.08k forks source link

How to make a pull request? #618

Closed Sajjon closed 8 years ago

Sajjon commented 8 years ago

Hi! I have tried to find the correct information regarding how to create a PR but I didn't get it.

I have clone the repo, created my own branch, committed and trying to post that branch to the repo. But the git push fails, because I do not have permission. How can I get permission to push a branch in order to create a PR?

Thanks!

matteocrippa commented 8 years ago

Hi @Sajjon you have to fork this repo first and then push to your repo, then you have to make a pull request, feel free to use the button on the top of the github page of your repo

Sajjon commented 8 years ago

@matteocrippa thanks for your quick reply, sorry for missing that, but maybe we can add that info to the Contributing guide?

I can add that you need to fork as part of my PR in https://github.com/matteocrippa/awesome-swift/blob/master/.github/CONTRIBUTING.md How does that sound?

Sajjon commented 8 years ago

Also might I suggest that everyone runs convert.rb script in order to generate the README.md and preview how it will look before making a PR?

I had to copy the convert.rb script from the .github folder to the root in order to run it. Using Sublime Text and the package Markdown preview and then previewed how it looks. Of course the copy of convert.rb should not be added to git. Maybe the path of the CONTENTS variable should be changed, so that it can be run from .github folder?

CONTENTS = 'contents.json'

changed to:

CONTENTS = '../contents.json'

Should I add this to the CONTRIBUTING.md too (apart from mentioning that you have to fork)?

Sajjon commented 8 years ago

Here is a PR #619 with the mentioning of fork in the CONTRIBUTING.md file, and also the Swift project I wanted to add.

Sajjon commented 8 years ago

What should I do to get the PR #619 approved and merged? :)

matteocrippa commented 8 years ago

@Sajjon I checked the repo, prob it's out of scope from this list, but @dkhamsing has a list of awesome open source apps, prob that repo best fit

Sajjon commented 8 years ago

@matteocrippa Thanks for your reply... However, I don't really understand why it is out of scope but practice-swift, learn-swift (updated 2 years ago...) is not?

My repo together with those two and others are repos with tutorials to learn swift. Many of the repos in the Third Party Guides list contain repos with small snippets that don't actually give you an understanding of how to build a "full app". My repo aims to give you an understanding of the full chain of creating an app, with GUI, data fetching (HTTP request best practices using generics), JSON parsing, protocol driven design. When to use structs, when to use classes. Building GUI using UIStoryboard as well as Xib.

I have also worked a with readability, all classes < 100 lines of code (except one, having less than 200, and it is one of the tasks to make that smaller).

Apart from that I have worked a lot with the tasks, to make them relevant, easy to understand, in an ascending order of complexity and fun.

Do you still don't think my repo is as good (or better) as other repos in the Third party guides list?

dkhamsing commented 8 years ago

Closing, thanks