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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Style guide style improvements #74

Closed
sambostock opened this issue Jul 21, 2017 · 6 comments
Closed

Style guide style improvements #74

sambostock opened this issue Jul 21, 2017 · 6 comments

Comments

@sambostock
Copy link
Contributor

sambostock commented Jul 21, 2017

Not a huge deal, but I thought I'd throw this out there.

I really like the way AirBnB does their Javascript Style Guide, for the following reasons:

  • Table of Contents 馃搫
  • Linking to specific sections 馃憟
  • Examples for almost everything, often with 馃槆 good vs 馃懣 bad
  • "Why"s on many style rules 馃

In my opinion, these make the style guide much more approachable to developers new to a language, as well as making the rules easier to share with others/refer to. I like having a "why" too, because rules make so much more sense when they aren't arbitrary.

@volmer
Copy link
Contributor

volmer commented Jul 22, 2017

I agree with the suggestions. It would be particularly nice to have links for each bullet point. Currently it's such a pain to reference portions of the style guide...

Pull requests are welcome!

I like having a "why" too, because rules make so much more sense when they aren't arbitrary

While some rules were chosen based on some clear benefits, there are lots of cases when a particular style is enforced for consistency only, and that's okay too.

@jules2689
Copy link
Contributor

Would anyone be against hosting it in dev-accel.shopify.io?

@sambostock
Copy link
Contributor Author

@jules2689 I think that would be neat, but it would mean it wouldn't be publicly available as it is now

@jules2689
Copy link
Contributor

Oh I didn't realize it was public

@sambostock
Copy link
Contributor Author

I would probably make sense to at least have a link to it on dev-accel though

@volmer
Copy link
Contributor

volmer commented Sep 15, 2020

Closing this in favour of more specific issues for each of the items described above. See #187 #188 #189 #190

@volmer volmer closed this as completed Sep 15, 2020
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

3 participants