search

rubocop / rspec-style-guide

Best practices for writing your specs!
http://rspec.rubystyle.guide
958 stars 118 forks source link

Restore references to original discussions and sources #98

Closed pirj closed 3 years ago

pirj commented 5 years ago

After conversion to AsciiDoc (#95) due to significant markup changes, the references to original discussions and sources were lost. A good place to check them is the result of git blame.

Example:

 Pick "use factories" rule from betterspecs

Original links:
http://www.betterspecs.org/#data
http://lelylan.github.io/betterspecs/#data
Discussion: lelylan/betterspecs#11
https://github.com/lelylan/betterspecs/blob/gh-pages/index.html#L573

Related:
http://blog.steveklabnik.com/posts/2012-07-14-why-i-don-t-like-factory_girl

Since this is a living document, it's very hard to rely on git blame in the long run to keep track of the sources. Having reference links to discussions in some way would be very helpful for the curious about the reasoning behind the recommendations.

Related to #89

pirj commented 3 years ago

This is something that is really hard to do.

And if for some reason a certain guideline is so unclear that even the guide maintainers can't explain the reasoning behind it, we should remove or significantly adjust such a guideline.