From 1197b2a02c8db06f0cb303d6ffb62f8999518f28 Mon Sep 17 00:00:00 2001 From: Josh McKinney Date: Mon, 28 Apr 2025 11:25:09 -0700 Subject: [PATCH] docs(contributing): add note about using nightly for formatting (#1816) --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c1f6cf6d..360519d1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,7 +32,14 @@ guarantee that the behavior is unchanged. ### Code formatting Run `cargo xtask format` before committing to ensure that code is consistently formatted with -rustfmt. Configuration is in [`rustfmt.toml`](./rustfmt.toml). +rustfmt. Configuration is in [`rustfmt.toml`](./rustfmt.toml). We use some unstable formatting +options as they lead to subjectively better formatting. These require a nightly version of Rust +to be installed when running rustfmt. You can install the nightly version of Rust using +[`rustup`](https://rustup.rs/): + +```shell +rustup install nightly +``` ### Search `tui-rs` for similar work