Skip to content
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

Use another style guide? #3

Open
modocache opened this issue May 4, 2015 · 4 comments
Open

Use another style guide? #3

modocache opened this issue May 4, 2015 · 4 comments

Comments

@modocache
Copy link
Member

How about we just use https://github.com/github/swift-style-guide or https://github.com/raywenderlich/swift-style-guide? That way someone else can do all the work of maintaining it, and we just have to follow it. 😉

I prefer the GitHub one.

@sharplet
Copy link

sharplet commented May 4, 2015

Just had a read, and it looks pretty good. I especially like the bit about 2-space indent, but that's probably impractical for this org. 😉

Speaking of which, we should probably add something about indentation settings being set explicitly in the Xcode project, so that contributors don't accidentally commit code with their potentially different personal indentation settings.

One other thing — I think the one about protocol conformance in separate extensions may be fine for application targets, but I think for framework authors it's problematic due to not being able to export public extensions in a module.

@paulyoung
Copy link

I basically follow the GitHub one anyway 👍

@modocache
Copy link
Member Author

I especially like the bit about 2-space indent, but that's probably impractical for this org.

I wouldn't be opposed to doing two giant pull requests to get Quick and Nimble in conformance with whatever we decide on.

Speaking of which, we should probably add something about indentation settings being set explicitly in the Xcode project, so that contributors don't accidentally commit code with their potentially different personal indentation settings.

Definitely!

One other thing...

Yeah, I think the best approach here is to put a link to an existing style guide, plus a few bullet points for exceptions. I'm pretty opposed to maintaining our own style guide (why reinvent the wheel?). Thoughts, @jeffh? Heck, we could even use the Pivotal Labs style guide, provided it's public. 😉

@jeffh
Copy link
Member

jeffh commented May 5, 2015

Sure, the github style guide works for me. 👍

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

No branches or pull requests

4 participants