Mention the setup instructions in CONTRIBUTING

Multiple people seem to have missed this based on questions asked in the
Discord channel. Might as well mention it up front.
This commit is contained in:
Vivek Ghaisas 2020-03-08 20:57:42 +00:00 committed by Vivek Ghaisas
parent 3d0f0e33af
commit 3b3e5ea2a2

View File

@ -28,8 +28,9 @@ High level approach:
1. Find something to fix/improve 1. Find something to fix/improve
2. Change code (likely some file in `clippy_lints/src/`) 2. Change code (likely some file in `clippy_lints/src/`)
3. Run `cargo test` in the root directory and wiggle code until it passes 3. Follow the instructions in the [docs for writing lints](doc/adding_lints.md) such as running the `setup-toolchain.sh` script
4. Open a PR (also can be done between 2. and 3. if you run into problems) 4. Run `cargo test` in the root directory and wiggle code until it passes
5. Open a PR (also can be done after 2. if you run into problems)
### Finding something to fix/improve ### Finding something to fix/improve