Skip to content

Commit

Permalink
Add a note about versioning policy
Browse files Browse the repository at this point in the history
  • Loading branch information
pirj committed Aug 22, 2020
1 parent d6050d5 commit 4d9df0e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/modules/ROOT/pages/index.adoc
Expand Up @@ -3,6 +3,12 @@
RSpec-specific analysis for your projects, as an extension to
https://github.com/rubocop-hq/rubocop[RuboCop].

RuboCop RSpec follows the https://docs.rubocop.org/rubocop/versioning.html[RuboCop versioning guide].
In a nutshell, between major versions new cops are introduced in a special `pending` status.
That means that they won't take their duties unless explicitly told otherwise.
RuboCop will warn on start that certain cops are neither explicitly enabled and disabled.
On a major version release, all new cops introduced since the previous major release, are enabled.

== Project Goals

* Enforce the guidelines and best practices outlined in the community https://rspec.rubystyle.guide[RSpec style guide]
Expand Down

0 comments on commit 4d9df0e

Please sign in to comment.