Quentin fd3a153103
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing
Fix the CONTRIBUTING doc for the new formatting
2021-09-20 15:18:49 +02:00

998 B

Contributing to Diplonat

Development guidelines

Code formatting

Our CI pipeline features a verification of the code format, using rustfmt.

Installing rustfmt

You must install a very recent version of rustfmt through rust nightly

To install:

rustup toolchain install nightly-x86_64-unknown-linux-gnu
rustup component add rustfmt --toolchain nightly


To run on Diplonat, launch the following in the root directory:

cargo +nightly fmt

This will format the whole repository using the settigs defined in .rustfmt.toml.

Auto-format code

You can automate formatting in a number of ways:

Setup your IDE to use rustfmt.

Setup a git hook to run rustfmt before each commit:

cat <<EOF > .git/hooks/pre-commit

cargo +nightly fmt
chmod +x .git/hooks/pre-commit