adrien/diplonat
1
0
Fork 0
forked from Deuxfleurs/diplonat
Code Issues Pull requests Projects Releases Wiki Activity

Fix the CONTRIBUTING doc for the new formatting

Browse source
This commit is contained in:
Quentin 2021-09-20 15:18:49 +02:00
parent 7d478d9976
commit fd3a153103
Signed by: quentin
GPG key ID: A98E9B769E4FF428
1 changed files with 17 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
CONTRIBUTING.md
View file

@ -8,12 +8,13 @@
#### Installing rustfmt #### 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: To install:
``` ```
rustup component add rustfmt rustup toolchain install nightly-x86_64-unknown-linux-gnu
rustup component add rustfmt --toolchain nightly
``` ```
#### Usage #### Usage
@ -21,14 +22,24 @@ rustup component add rustfmt
To run on Diplonat, launch the following in the root directory: 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 #### Auto-format code
You can automate formatting in a number of ways: 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 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 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
```