-
Notifications
You must be signed in to change notification settings - Fork 147
docs: add semantic versioning policy #387
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Semantic Versioning Policy | ||
|
||
`eslint-plugin-testing-library` follows [Semantic Versioning](https://semver.org/). However, for [the same reason as ESLint itself](https://github.com/eslint/eslint#semantic-versioning-policy), it's not always clear when a minor or major version bump occurs. To help clarify this for everyone, we've defined the following Semantic Versioning Policy for this ESLint plugin: | ||
|
||
- Patch release (intended to not break your lint build) | ||
- A bug fix in a rule that results in `eslint-plugin-testing-library` reporting fewer errors. | ||
- A bug fix to the core. | ||
- Re-releasing after a failed release (i.e., publishing a release that doesn't work for anyone). | ||
- A dependency gets updated | ||
- Minor release (might break your lint build) | ||
- A bug fix in a rule that results in `eslint-plugin-testing-library` reporting more errors. | ||
- A new rule is created. | ||
- A new option to an existing rule that does not result in ESLint reporting more errors by default. | ||
- A new option to an existing rule that might result in ESLint reporting more errors by default. | ||
- A new addition to an existing rule to support a newly-added Testing Library feature that will result in `eslint-plugin-testing-library` reporting more errors by default. | ||
- An existing rule is deprecated. | ||
- New capabilities to the public API are added (new classes, new methods, new arguments to existing methods, etc.). | ||
- A new shareable configuration is created. | ||
- An existing shareable configuration is updated and will result in strictly fewer errors (e.g., rule removals). | ||
- Support for a Node major version is added. | ||
- Major release (likely to break your lint build) | ||
- An existing shareable configuration is updated and may result in new errors (e.g., rule additions, most rule option updates). | ||
- Part of the public API is removed or changed in an incompatible way. The public API includes: | ||
- Rule schemas | ||
- Configuration schema | ||
- Support for a Node major version is dropped. | ||
|
||
According to our policy, any minor update may report more errors than the previous release (ex: from a bug fix). As such, we recommend using the tilde (`~`) in `package.json` e.g. `"eslint-plugin-testing-library": "~4.3.0"` to guarantee the results of your builds. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As discussed in #353, this is the main difference from ESLint SemVer Policy so it's a minor instead of a major.