aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorQuentin Dufour <quentin@deuxfleurs.fr>2021-09-20 15:18:49 +0200
committerQuentin Dufour <quentin@deuxfleurs.fr>2021-09-20 15:18:49 +0200
commitfd3a153103029cf7b740e3feeb27eadf5fa4eefc (patch)
tree94eefd784b756a4dd13e4dcb71431708c8501b07
parent7d478d997620c0af41a6ffb8b3f29dc6dda2cb98 (diff)
downloaddiplonat-fd3a153103029cf7b740e3feeb27eadf5fa4eefc.tar.gz
diplonat-fd3a153103029cf7b740e3feeb27eadf5fa4eefc.zip
Fix the CONTRIBUTING doc for the new formattingquality/rustfmt
-rw-r--r--CONTRIBUTING.md23
1 files changed, 17 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f8de6cc..01e1e12 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -8,12 +8,13 @@
#### Installing rustfmt
-You can run `rustfmt` with Rust 1.24 and above.
+You must install a very recent version of `rustfmt` through rust nightly
To install:
```
-rustup component add rustfmt
+rustup toolchain install nightly-x86_64-unknown-linux-gnu
+rustup component add rustfmt --toolchain nightly
```
#### Usage
@@ -21,14 +22,24 @@ rustup component add rustfmt
To run on Diplonat, launch the following in the root directory:
```
-cargo fmt --all
+cargo +nightly fmt
```
-This will format the whole repository using the settigs defined in [`.rustfmt.toml`](./.rustfmt.toml): soft tabs of 2 spaces.
+This will format the whole repository using the settigs defined in [`.rustfmt.toml`](./.rustfmt.toml).
#### Auto-format code
You can automate formatting in a number of ways:
-* [Setup your IDE to use `rustfmt`](https://github.com/rust-lang/rustfmt#running-rustfmt-from-your-editor).
-* Setup a git hook to run `rustfmt` before each commit.
+[Setup your IDE to use `rustfmt`](https://github.com/rust-lang/rustfmt#running-rustfmt-from-your-editor).
+
+Setup a git hook to run `rustfmt` before each commit:
+
+```bash
+cat <<EOF > .git/hooks/pre-commit
+#!/bin/bash
+
+cargo +nightly fmt
+EOF
+chmod +x .git/hooks/pre-commit
+```