]> git.lizzy.rs Git - rust.git/blobdiff - CONTRIBUTING.md
Fix rvm/gpg bug in travis osx build
[rust.git] / CONTRIBUTING.md
index 7ee74448a0929a1fd3015c203c48ddccaba26453..b5548bdd732a3b55f67ee7f583173005b9696675 100644 (file)
@@ -19,10 +19,10 @@ All contributors are expected to follow the [Rust Code of Conduct](http://www.ru
   * [Running test suite](#running-test-suite)
   * [Running rustfmt](#running-rustfmt)
   * [Testing manually](#testing-manually)
-  * [Linting Clippy with your local changes](#linting-clippy-with-your-local-changes)
   * [How Clippy works](#how-clippy-works)
   * [Fixing nightly build failures](#fixing-build-failures-caused-by-rust)
 * [Issue and PR Triage](#issue-and-pr-triage)
+* [Bors and Homu](#bors-and-homu)
 * [Contributions](#contributions)
 
 ## Getting started
@@ -156,7 +156,7 @@ to style guidelines. The code has to be formatted by `rustfmt` before a PR will
 
 It can be installed via `rustup`:
 ```bash
-rustup component add rustfmt-preview
+rustup component add rustfmt
 ```
 
 Use `cargo fmt --all` to format the whole codebase.
@@ -168,18 +168,6 @@ Manually testing against an example file is useful if you have added some
 local modifications, run `env CLIPPY_TESTS=true cargo run --bin clippy-driver -- -L ./target/debug input.rs`
 from the working copy root.
 
-### Linting Clippy with your local changes
-
-Clippy CI only passes if all lints defined in the version of the Clippy being
-tested pass (that is, don’t report any suggestions). You can avoid prolonging
-the CI feedback cycle for PRs you submit by running these lints yourself ahead
-of time and addressing any issues found:
-
-```
-cargo build
-`pwd`/target/debug/cargo-clippy clippy --all-targets --all-features -- -D clippy::all -D clippy::internal -D clippy::pedantic
-```
-
 ### How Clippy works
 
 Clippy is a [rustc compiler plugin][compiler_plugin]. The main entry point is at [`src/lib.rs`][main_entry]. In there, the lint registration is delegated to the [`clippy_lints`][lint_crate] crate.
@@ -232,7 +220,7 @@ That's why the `else_if_without_else` example uses the `register_early_lint_pass
 
 ### Fixing build failures caused by Rust
 
-Clippy will sometimes break because it still depends on unstable internal Rust features. Most of the times we have to adapt to the changes and only very rarely there's an actual bug in Rust. Fixing build failures caused by Rust updates, can be a good way to learn about Rust internals.
+Clippy will sometimes fail to build from source because building it depends on unstable internal Rust features. Most of the times we have to adapt to the changes and only very rarely there's an actual bug in Rust. Fixing build failures caused by Rust updates, can be a good way to learn about Rust internals.
 
 In order to find out why Clippy does not work properly with a new Rust commit, you can use the [rust-toolstate commit history][toolstate_commit_history].
 You will then have to look for the last commit that contains `test-pass -> build-fail` or `test-pass` -> `test-fail` for the `clippy-driver` component. [Here][toolstate_commit] is an example.
@@ -269,6 +257,17 @@ Our highest priority is fixing [crashes][l-crash] and [bugs][l-bug]. We don't
 want Clippy to crash on your code and we want it to be as reliable as the
 suggestions from Rust compiler errors.
 
+## Bors and Homu
+
+We use a bot powered by [Homu][homu] to help automate testing and landing of pull
+requests in Clippy. The bot's username is @bors.
+
+You can find the Clippy bors queue [here][homu_queue].
+
+If you have @bors permissions, you can find an overview of the available
+commands [here][homu_instructions].
+
+
 ## Contributions
 
 Contributions to Clippy should be made in the form of GitHub pull requests. Each pull request will
@@ -300,3 +299,6 @@ or the [MIT](http://opensource.org/licenses/MIT) license.
 [triage]: https://forge.rust-lang.org/triage-procedure.html
 [l-crash]: https://github.com/rust-lang/rust-clippy/labels/L-crash%20%3Aboom%3A
 [l-bug]: https://github.com/rust-lang/rust-clippy/labels/L-bug%20%3Abeetle%3A
+[homu]: https://github.com/servo/homu
+[homu_instructions]: https://buildbot2.rust-lang.org/homu/
+[homu_queue]: https://buildbot2.rust-lang.org/homu/queue/clippy