Skip to content

Commit

Permalink
Update versioning policy for editor integration
Browse files Browse the repository at this point in the history
  • Loading branch information
dhruvmanila committed Jul 18, 2024
1 parent 2e77b77 commit 311dda0
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion docs/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,12 @@ Ruff uses a custom versioning scheme that uses the **minor** version number for
- Stable rules are added to the default set
- Stable rules are removed from the default set
- A safe fix for a rule is promoted to stable
- Formatter:
- Formatter:
- The stable style changed
- Language server:
- The behavior of an existing capability is changed
- The scope of an existing capability is significantly increased
- A deprecated server setting is removed

**Patch** version increases will occur when:

Expand All @@ -40,6 +44,10 @@ Ruff uses a custom versioning scheme that uses the **minor** version number for
- Formatter:
- The stable style changed to prevent invalid syntax, changes to the program's semantics, or removal of comments
- The preview style changed
- Language server:
- Support for a new capability is added
- A new server setting is added
- A server setting is deprecated


## Preview mode
Expand Down Expand Up @@ -70,3 +78,13 @@ Fixes have three applicability levels:
- **Safe**: Can be applied automatically.

Fixes for rules may be introduced at a lower applicability, then promoted to a higher applicability. Reducing the applicability of a fix is not a breaking change. The applicability of a given fix may change when the preview mode is enabled.

## Visual Studio Code Extension

Visual Studio Code [doesn't support pre-release
tags](https://code.visualstudio.com/api/working-with-extensions/publishing-extension#prerelease-extensions)
for extensions. That’s why Ruff uses the following version schema to distinguish stable and
previews:

Stable releases use even version numbers: 10, 12, 14, 16, …
Previews use odd version numbers: 11, 13, 15, 17, …

0 comments on commit 311dda0

Please sign in to comment.