From a84a85a7a651b9c8933a1aa8e772fcd3396a0a83 Mon Sep 17 00:00:00 2001 From: Awiteb Date: Sun, 5 May 2024 19:08:17 +0300 Subject: [PATCH] chore(DX): Add `rust-toolchain.toml` I see is better to develop the project in `nightly` channel to take advantage of rustfmt and rust-analyzer features. --- CONTRIBUTING.md | 5 +++++ rust-toolchain.toml | 13 +++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 rust-toolchain.toml diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a90c2a..3318937 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,6 +13,11 @@ If you have a feature request or an idea for improving lprs, we encourage you to ## Writing Code Before you start writing code, please open a new issue first to discuss the proposed changes. This will help ensure that your contribution is aligned with the project's goals and that you are not duplicating work that is already in progress or has been completed by someone else. +### Rust Version +In the lprs project, we always try to stay on the lowest MSRV possible for compatibility, but the development process relies on the nightly release to get the latest rust-analyzer, rustfmt, and clippy features. + +You can check the nightly version used in the project in the `rust-toolchain` file. And the MSRV in the `Cargo.toml` file. + ### PR title Your PR will squash and merge, and your PR title will be used as the commit message. Please make sure your PR title is clear and concise. diff --git a/rust-toolchain.toml b/rust-toolchain.toml new file mode 100644 index 0000000..523c157 --- /dev/null +++ b/rust-toolchain.toml @@ -0,0 +1,13 @@ +[toolchain] +# We use nightly in development only, the project will always be compliant with +# the latest stable release and the MSRV as defined in `Cargo.toml` file. +channel = "nightly-2024-05-05" +components = [ + "rustc", + "cargo", + "rust-std", + "rust-src", + "rustfmt", + "rust-analyzer", + "clippy", +]