Skip to content

Commit

Permalink
Document MSRV in the stability guide (#298)
Browse files Browse the repository at this point in the history
  • Loading branch information
Byron committed Jan 20, 2022
1 parent 9c14de3 commit 5f66ee0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -102,7 +102,7 @@ Many crates use feature flags to allow tuning the compiled result based on your

[cargo-features]: https://github.com/Byron/gitoxide/blob/main/cargo-features.md#git-config

### Stability
### Stability and MSRV

Our [stability guide] helps to judge how much churn can be expected when depending on crates in this workspace.

Expand Down
7 changes: 4 additions & 3 deletions STABILITY.md
Expand Up @@ -118,11 +118,12 @@ Once breaking changes are known to be planned, deprecation warnings should be pr

Minor version updates for new features can be released when needed assuming there are no other breaking changes, updating the build identifiers for year and month accordingly.

## The _Minimal Stable Rust Version_ (->MSRV)
## The _Minimal Supported Rust Version_ (->MSRV)

The MSRV is automatically assumed to be the latest stable version.
The MSRV is automatically assumed to be the latest stable version for all crates with the following exception: `git-repository` and all it's dependencies must
adhere to an MSRV, as validated by the `msrv.yml` GitHub workflow.

Increasing the MSRV is not considered a breaking change and doesn't warrant a major version bump itself.
Increasing the MSRV is considered a breaking change and warrants a major version bump itself for stable crates and a minor version bump for pre-release crates.

Please let us know if you have other requirement and we see if we can provide stability guarantees for it or reduce the MSRV to a given version.

Expand Down

0 comments on commit 5f66ee0

Please sign in to comment.