awiteb/lprs
1
Fork 0
Code Issues 2 Pull requests Releases 3 Activity Actions

chore(DX): Add rust-toolchain.toml

Browse source 
I see is better to develop the project in `nightly` channel
to take advantage of rustfmt and rust-analyzer features.
This commit is contained in:
Awiteb 2024-05-05 19:08:17 +03:00
parent f8086b24ff
commit a84a85a7a6
Signed by: awiteb
GPG key ID: 3F6B55640AA6682F
2 changed files with 18 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
CONTRIBUTING.md
View file

@ -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.

13
rust-toolchain.toml Normal file
View file

@ -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",
]