Skip to content

Commit bd71b01

Browse files
committed
Make the docs clearer for new contributors
* Add an easy-to-see note at the top of `CONTRIBUTING.md` that points new contributors to the Basics docs * Add a note about compiler errors as a result of internals changes that break Clippy
1 parent 2d4c337 commit bd71b01

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,14 @@ All contributors are expected to follow the [Rust Code of Conduct].
2828

2929
## Getting started
3030

31-
High level approach:
31+
**Note: If this is your first time contributing to Clippy, you should
32+
first read the [Basics docs](doc/basics.md).**
33+
34+
### High level approach
3235

3336
1. Find something to fix/improve
3437
2. Change code (likely some file in `clippy_lints/src/`)
35-
3. Follow the instructions in the [Basics docs](doc/basics.md) such as running the `setup-toolchain.sh` script
38+
3. Follow the instructions in the [Basics docs](doc/basics.md) to get set up
3639
4. Run `cargo test` in the root directory and wiggle code until it passes
3740
5. Open a PR (also can be done after 2. if you run into problems)
3841

doc/basics.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@ rustup-toolchain-install-master -f -n master -c rustc-dev -c llvm-tools
5353
rustup override set master
5454
```
5555

56+
_Note:_ Sometimes you may get compiler errors when building Clippy, even if you
57+
didn't change anything. Normally those will be fixed by a maintainer in a few hours.
58+
5659
## Building and Testing
5760

5861
Once the `master` toolchain is installed, you can build and test Clippy like

0 commit comments

Comments
 (0)