Skip to content

Conversation

andyw8
Copy link
Contributor

@andyw8 andyw8 commented Aug 2, 2022

Using the definite article the could imply this is the 'one true' or 'official' style guide. Although it's certainly the most commonly used and referenced, I think this is an important distinction to make.

(if this is accepted, I'll make corresponding updates to the Rails Style Guide, etc.)

@bbatsov
Copy link
Collaborator

bbatsov commented Aug 2, 2022

I get the point of the suggestion, but I profoundly dislike how "Ruby Style Guide" sounds/reads (pretty vague and generic). Originally I was going for "the (one) Ruby community style guide", but spelling it out completely was a bit of mouthful, that's why it normally ended as "the Ruby style guide". I hope this makes sense.

Funny enough, today almost all popular Ruby style guides are derived in some way from this one, so I guess it could have accidentally become "the" Ruby style guide.

@andyw8
Copy link
Contributor Author

andyw8 commented Aug 2, 2022

How about replacing the title with the current repo description? A community-driven Ruby coding style guide

@pirj
Copy link
Member

pirj commented Aug 2, 2022

I've been collecting a list of Ruby Style guides

 https://www.reddit.com/r/ruby/comments/c2dy1p/the_ruby_style_guide/?st=jx80o9t1&sh=97926d2e https://github.com/airbnb/ruby https://github.com/github/rubocop-github/blob/master/STYLEGUIDE.md https://github.com/franzejr/best-ruby https://shopify.github.io/ruby-style-guide/ http://www.caliban.org/ruby/rubyguide.shtml#style https://about.lessonly.engineering/styleguide/ruby/ https://github.com/chef/chef-web-docs/blob/master/chef_master/source/ruby.rst https://relaxed.ruby.style https://github.com/xaviershay/writing/blob/master/code/ruby_style_guide.rb https://github.com/bestie/objective-ruby-style-guide https://github.com/thoughtbot/guides/tree/master/style/ruby https://github.com/leahneukirchen/styleguide/blob/master/RUBY-STYLE https://gist.github.com/nathanpc/473d35c95e4f3dae954c0bd2f2bd72d3 https://praxis.scholarslab.org/resources/ruby-style-guide/ http://sportngin.github.io/styleguide/ruby https://github.com/leahneukirchen/styleguide/blob/master/RUBY-STYLE 

To my best memory, most of them are derived from the guide.

A note from a sibling repo: since the RSpec Style guide is not the Official RSpec Style guide, it's been suggested to rename it to "the Community RSpec Style guide".

I'd say that this could be applied to The Ruby Style guide as well:

mostly based on the professional experience of the editors, feedback and suggestions from members of the Ruby community and various highly regarded Ruby programming resources

"The" and "Community" at the same time don't describe any other guide on the list above.

@miry
Copy link

miry commented Aug 2, 2022

I think more and more popularity gains: https://github.com/testdouble/standard

@pirj
Copy link
Member

pirj commented Aug 2, 2022

StandardRB is essentially a wrapper on top of RuboCop

RuboCop... Out of the box it will enforce many of the guidelines outlined in the community Ruby Style Guide.

@bbatsov bbatsov merged commit 4379d61 into master Aug 3, 2022
@bbatsov
Copy link
Collaborator

bbatsov commented Aug 3, 2022

Oh, well - let's not overthink this.

@bbatsov bbatsov deleted the andyw8/remove-definite-article branch August 3, 2022 07:39
@bbatsov
Copy link
Collaborator

bbatsov commented Aug 3, 2022

I've been collecting a list of Ruby Style guides

@pirj We might mention them somewhere near the end of our style guide, as some points of reference.

https://github.com/leahneukirchen/styleguide/blob/master/RUBY-STYLE predates our style guide (I remember reading while working on the first version of our guide) - it might be the oldest Ruby style guide there is. :-)

To my best memory, most of them are derived from the guide.

andyw8 added a commit to rubocop/rails-style-guide that referenced this pull request Aug 3, 2022
andyw8 added a commit to rubocop/minitest-style-guide that referenced this pull request Aug 3, 2022
andyw8 added a commit to andyw8/rspec-style-guide that referenced this pull request Aug 3, 2022
andyw8 added a commit to andyw8/rspec-style-guide that referenced this pull request Aug 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

4 participants