Skip to content

Commit

Permalink
docs: Elaborate on the MSRV policy
Browse files Browse the repository at this point in the history
Previously bumps in the MSRV were treated as breaking changes. However this is
unsustainable for a stable release, as some of our dependencies take bumps in
the MSRV as minor version bumps. This adds a section to the MSRV policy describing
what kind of version bumps we expect to take with regards to MSRV.

The policy is mostly copied from smol.

Signed-off-by: John Nunley <dev@notgull.net>
  • Loading branch information
notgull committed May 30, 2024
1 parent 082dee3 commit 34870e6
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,4 +151,8 @@ The current MSRV (Minimum Safe Rust Version) for this crate is Rust **1.63**.
When the `signals` feature is enabled, however, it will be bumped to `nix`'s
MSRV. At the time of writing this is Rust **1.69**.

Prior to `calloop` v1.0, bumps in the MSRV will result in bumps to the patch version. Once `calloop` v1.0 is release, bumps in the MSRV will result in bumps to the minor version. In short, MSRV bumps are not considered breaking changes.

As a **tentative** policy, the base MSRV will not advance past the [current Rust version provided by Debian Stable](https://packages.debian.org/stable/rust/rustc). At the time of writing, this version of Rust is *1.63*. However, the MSRV may be advanced further in the event of a major ecosystem shift or a security vulnerability.

License: MIT

0 comments on commit 34870e6

Please sign in to comment.