| 1 | # Semantic versioning
|
| 2 |
|
| 3 | Due to the nature of stylelint as a code quality tool, we follow a specific flavor of [semantic versioning](http://semver.org).
|
| 4 |
|
| 5 | Any minor update may report more errors than the previous release. As such, we recommend using the tilde (`~`) in `package.json` e.g. `"stylelint": "~7.2.0"` to guarantee the results of your builds.
|
| 6 |
|
| 7 | ## Patch release
|
| 8 |
|
| 9 | Intended not to break your lint build:
|
| 10 |
|
| 11 | - a bug fix in a rule that results in stylelint reporting fewer errors
|
| 12 | - a bug fix to the CLI or core (including formatters)
|
| 13 | - improvements to documentation
|
| 14 | - non-user-facing changes such as refactoring code or modifying tests
|
| 15 | - re-releasing after a failed release (i.e., publishing a release that doesn't work for anyone)
|
| 16 |
|
| 17 | ## Minor release
|
| 18 |
|
| 19 | Might break your lint build:
|
| 20 |
|
| 21 | - a bug fix in a rule that results in stylelint reporting more errors
|
| 22 | - a new rule is created
|
| 23 | - a new option to an existing rule that does not result in stylelint reporting more errors by default
|
| 24 | - an existing rule is deprecated
|
| 25 | - a new CLI capability is created
|
| 26 | - a new public API capability is created
|
| 27 | - a new formatter is created
|
| 28 |
|
| 29 | ## Major release
|
| 30 |
|
| 31 | Likely to break your lint build:
|
| 32 |
|
| 33 | - a change in the documented behavior of an existing rule results in stylelint reporting more errors by default
|
| 34 | - an existing rule is removed
|
| 35 | - an existing formatter is removed
|
| 36 | - part of the CLI is removed or changed in an incompatible way
|
| 37 | - part of the public API is removed or changed in an incompatible way
|