Skip to content

Commit

Permalink
Clarify the API stability wording
Browse files Browse the repository at this point in the history
Previously the wording implied that between major versions the API won't change.
But it's pretty clear from the surrounding wording and general semvar concept
that the API _will_ change between major versions... it's only between minor/patch
versions that it won't change.
  • Loading branch information
jeffwidman authored and bbatsov committed Aug 1, 2022
1 parent b2594cf commit b80ea40
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -46,7 +46,7 @@ If you'd rather install RuboCop using `bundler`, add a line for it in your `Gemf
gem 'rubocop', require: false
```

RuboCop is stable between major versions, both in terms of API and cop configuration.
RuboCop is stable between minor versions, both in terms of API and cop configuration.
We aim to ease the maintenance of RuboCop extensions and the upgrades between RuboCop
releases. All big changes are reserved for major releases.
To prevent an unwanted RuboCop update you might want to use a conservative version lock
Expand Down

0 comments on commit b80ea40

Please sign in to comment.