Update CONTRIBUTING.md
authorlukaslueg <lukas.lueg@gmail.com>
Mon, 19 Mar 2018 18:40:39 +0000 (19:40 +0100)
committerGitHub <noreply@github.com>
Mon, 19 Mar 2018 18:40:39 +0000 (19:40 +0100)
Since a13a33c33b049a7b412f0cc80a7b166b0d58345c code is rejected during CI if `rustfmt` complains. Update the docs regarding that fact.

CONTRIBUTING.md

index ed260e51a26c12e7e059fd112d3de2fb853e1501..55b29fe15ea51f998c268d4f2469d4698af6697f 100644 (file)
@@ -81,6 +81,10 @@ of helpers to minimize boilerplate.
 installed locally, ignore the cross-compile test failures or disable them by
 using `CFG_DISABLE_CROSS_TESTS=1 cargo test`. Note that some tests are enabled
 only on `nightly` toolchain. If you can, test both toolchains.
+* All code is expected to comply with the formatting suggested by `rustfmt`;
+discrepancy is considered an error by CI, so a pull request with unsound
+formatting will not be accepted. You can use `rustup component add rustfmt-preview`
+to install `rustfmt` and use `cargo fmt` to automatically format your code.
 * Push your commits to GitHub and create a pull request against Cargo's
 `master` branch.