From 0ff5f314f17df01f9b344c9e0ac8b7076eabd36c Mon Sep 17 00:00:00 2001 From: lukaslueg Date: Mon, 19 Mar 2018 19:40:39 +0100 Subject: [PATCH] Update CONTRIBUTING.md Since a13a33c33b049a7b412f0cc80a7b166b0d58345c code is rejected during CI if `rustfmt` complains. Update the docs regarding that fact. --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ed260e51a..55b29fe15 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. -- 2.30.2