diff options
| author | har7an <99636919+har7an@users.noreply.github.com> | 2026-01-07 06:11:25 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-01-07 06:11:25 +0000 |
| commit | 8aba80ebcc8cc22c455ebcf377ef2793c459a4e3 (patch) | |
| tree | 836e4dc2ad09375b3ed1751678f1a0a441bc411c | |
| parent | build: Update Rust toolchain to 1.92.0 (#4579) (diff) | |
| download | sl0ppij-8aba80ebcc8cc22c455ebcf377ef2793c459a4e3.tar.gz sl0ppij-8aba80ebcc8cc22c455ebcf377ef2793c459a4e3.tar.xz sl0ppij-8aba80ebcc8cc22c455ebcf377ef2793c459a4e3.zip | |
docs(CONTRIBUTING): Describe rust toolchain versioning policy (#4585)
* docs(CONTRIBUTING): Describe rust toolchain versioning policy
and mention the lack of a MSRV. This should allow people to discover how
toolchain updates are handled, even though there currently isn't much of
an explanation.
* docs(CHANGELOG): Mention PR #4585
which describes the Rust toolchain versioning policy.
| -rw-r--r-- | CHANGELOG.md | 1 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 25 |
2 files changed, 26 insertions, 0 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 7b6808e6..3aca1dc7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,6 +20,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) * feat: read-only web authentication-tokens (https://github.com/zellij-org/zellij/pull/4551) * feat: allow overriding layouts at runtime (https://github.com/zellij-org/zellij/pull/4566) * build: Update Rust toolchain to 1.92.0 (https://github.com/zellij-org/zellij/pull/4579) +* docs: Explain Rust toolchain update strategy in CONTRIBUTING (https://github.com/zellij-org/zellij/pull/4585) ## [0.43.1] - 2025-08-08 * fix: pane rename backspace regression (https://github.com/zellij-org/zellij/pull/4346) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9310cf91..682bce3c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -106,6 +106,31 @@ Since we just cannot afford to manage them, we are always welcome to fix them! Here is [the detailed discussion](https://github.com/zellij-org/zellij/pull/1090) if you want to see it. + +## Toolchain Versions and MSRV + +Development aims to track the current stable Rust toolchain version, although +with a slight delay. The reason behind this is that users running `cargo +install --locked zellij` will use whatever toolchain version they have +installed locally and we cannot influence this (except for terminating +compilation on a "mismatch" from our expectation). By using current toolchain +versions we hope to ensure that bugs are caught before users experience them. +It hopefully also ensures that (at least for a certain time after a release has +been made) the binary obtained by installation from source doesn't deviate +(much at least) from the pre-built binaries attached as release assets. The +delay in toolchain updates is due to a certain amount of manual testing that is +performed afterward. + +At this point in time, there is no MSRV policy. As our resources are limited, +we try to focus on making the code work with whatever development toolchain is +currently mentioned in `rust-toolchain.toml`. While it may still be possible to +compile Zellij with older Rust versions, we cannot offer support in such +situations. + +For questions and suggestions regarding the currently used Rust toolchain +version, please mention @har7an in your issue or pull request. + + ## Looking for something to work on? If you are new contributor to `Zellij` going through |
