Be aware of the RSpec Style Guide, but how to contribute?

[Jack Royal-Gordon]

I thought I’d put this out there so that others don’t make the same mistake I did. I just found the RSpec Style Guide (https://rspec.rubystyle.guide) AFTER I’ve been writing specs for a couple months. An excellent read, and I have a few places where I might suggest additions. The end of the article says that you can contribute and talks about forking the project, but there is no link to the project and I’m not able to locate one (for the style guide itself).

[Phil Pirozhkov]

Hi Jack,

Actually the guide you are referring to is a community-driven one, not an official guide. I'm not diminishing its usefulness, it's quite good, but it doesn't reflect the opinion of the RSpec Core team.

There's a ticket to create a brief official style guide https://github.com/rspec/rspec.github.io/issues/28, it's on the top of my list actually.

It's quite unfortunate that the published version of the guide doesn't refer back to its source, https://github.com/rubocop-hq/rspec-style-guide/

Pull requests are welcome. I have two just off the top of my head:

 - add a link to the source for easier contributions

 - request specs vs controller specs, this section is years old

- Phil

On Thu, Aug 13, 2020 at 1:37 AM Jack Royal-Gordon <jac...@pobox.com> wrote:

I thought I’d put this out there so that others don’t make the same mistake I did. I just found the RSpec Style Guide (https://rspec.rubystyle.guide) AFTER I’ve been writing specs for a couple months. An excellent read, and I have a few places where I might suggest additions. The end of the article says that you can contribute and talks about forking the project, but there is no link to the project and I’m not able to locate one (for the style guide itself).

--
You received this message because you are subscribed to the Google Groups "rspec" group.
To unsubscribe from this group and stop receiving emails from it, send an email to rspec+un...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/rspec/E8594B90-2D1E-4105-AA59-797FB80876A3%40pobox.com.

[Jack Royal-Gordon]

Thanks, Phil. I guess the fact that it’s official might explain why I didn’t find it until now. I think an official guide would be very useful. And I suppose that the authors of that guide wouldn’t be very happy with their guide being the starting point for an official guide from the RSpec Core team? 

To view this discussion on the web visit https://groups.google.com/d/msgid/rspec/CAAk5Ok9uN%3DmJoXb_sUOu4QQYP-_D87V6H%2BkKoBKjjZyHux_R_Q%40mail.gmail.com.

[Phil Pirozhkov]

I'm currently maintaining that community guide and I don't see any problem with that.

To view this discussion on the web visit https://groups.google.com/d/msgid/rspec/C95C6D28-2956-4F38-ABFD-B5A37256E37F%40pobox.com.

[Jack Royal-Gordon]

Good to know, Phil. I just sent a PR to add a link to the GitHub project to the document.

To view this discussion on the web visit https://groups.google.com/d/msgid/rspec/CAAk5Ok8uiPLr%3DPZcjJg_PPQKsWjo1r_48iJ%2B%3DvdUZxDho4uuCQ%40mail.gmail.com.