Skip to content

Commit 1b93f8d

Browse files
committed
Auto merge of #3524 - phansch:update_contributing, r=phansch
Small updates to CONTRIBUTING.md None
2 parents 02512c1 + 740634a commit 1b93f8d

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ All contributors are expected to follow the [Rust Code of Conduct](http://www.ru
2323
* [How Clippy works](#how-clippy-works)
2424
* [Fixing nightly build failures](#fixing-build-failures-caused-by-rust)
2525
* [Issue and PR Triage](#issue-and-pr-triage)
26+
* [Bors and Homu](#bors-and-homu)
2627
* [Contributions](#contributions)
2728

2829
## Getting started
@@ -156,7 +157,7 @@ to style guidelines. The code has to be formatted by `rustfmt` before a PR will
156157

157158
It can be installed via `rustup`:
158159
```bash
159-
rustup component add rustfmt-preview
160+
rustup component add rustfmt
160161
```
161162

162163
Use `cargo fmt --all` to format the whole codebase.
@@ -220,7 +221,7 @@ That's why the `else_if_without_else` example uses the `register_early_lint_pass
220221

221222
### Fixing build failures caused by Rust
222223

223-
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.
224+
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.
224225

225226
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].
226227
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.
@@ -257,6 +258,17 @@ Our highest priority is fixing [crashes][l-crash] and [bugs][l-bug]. We don't
257258
want Clippy to crash on your code and we want it to be as reliable as the
258259
suggestions from Rust compiler errors.
259260

261+
## Bors and Homu
262+
263+
We use a bot powered by [Homu][homu] to help automate testing and landing of pull
264+
requests in Clippy. The bot's username is @bors.
265+
266+
You can find the Clippy bors queue [here][homu_queue].
267+
268+
If you have @bors permissions, you can find an overview of the available
269+
commands [here][homu_instructions].
270+
271+
260272
## Contributions
261273

262274
Contributions to Clippy should be made in the form of GitHub pull requests. Each pull request will
@@ -288,3 +300,6 @@ or the [MIT](http://opensource.org/licenses/MIT) license.
288300
[triage]: https://forge.rust-lang.org/triage-procedure.html
289301
[l-crash]: https://github.com/rust-lang/rust-clippy/labels/L-crash%20%3Aboom%3A
290302
[l-bug]: https://github.com/rust-lang/rust-clippy/labels/L-bug%20%3Abeetle%3A
303+
[homu]: https://github.com/servo/homu
304+
[homu_instructions]: https://buildbot2.rust-lang.org/homu/
305+
[homu_queue]: https://buildbot2.rust-lang.org/homu/queue/clippy

0 commit comments

Comments
 (0)