itsscb/cargo
1
0
Fork 0
mirror of https://github.com/rust-lang/cargo.git synced 2025-10-01 11:30:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Auto merge of #5206 - lukaslueg:patch-1, r=matklad

Browse Source 
Update CONTRIBUTING.md

Since a13a33c33b049a7b412f0cc80a7b166b0d58345c code is rejected during CI if `rustfmt` complains. Update the docs regarding that fact.
This commit is contained in:
bors 2018-03-20 13:27:30 +00:00
commit 1f306dbc61
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -81,6 +81,10 @@ of helpers to minimize boilerplate.
installed locally, ignore the cross-compile test failures or disable them by 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 using `CFG_DISABLE_CROSS_TESTS=1 cargo test`. Note that some tests are enabled
only on `nightly` toolchain. If you can, test both toolchains. 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 * Push your commits to GitHub and create a pull request against Cargo's
`master` branch. `master` branch.