diff options
| author | Camelid <37223377+camelid@users.noreply.github.com> | 2020-08-07 14:21:14 -0700 |
|---|---|---|
| committer | Camelid <camelidcamel@gmail.com> | 2020-08-07 16:15:44 -0700 |
| commit | bd71b01a8280dd0faa02416b7064ce170c1b40f5 (patch) | |
| tree | 174451128a6cc59d7b06a98f6b59074c26ce6051 /CONTRIBUTING.md | |
| parent | 2d4c3379d355c436342113a302421faf3990fb29 (diff) | |
| download | rust-bd71b01a8280dd0faa02416b7064ce170c1b40f5.tar.gz rust-bd71b01a8280dd0faa02416b7064ce170c1b40f5.zip | |
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
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dfc5cc077c3..5f7b1e85ee9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -28,11 +28,14 @@ All contributors are expected to follow the [Rust Code of Conduct]. ## Getting started -High level approach: +**Note: If this is your first time contributing to Clippy, you should +first read the [Basics docs](doc/basics.md).** + +### High level approach 1. Find something to fix/improve 2. Change code (likely some file in `clippy_lints/src/`) -3. Follow the instructions in the [Basics docs](doc/basics.md) such as running the `setup-toolchain.sh` script +3. Follow the instructions in the [Basics docs](doc/basics.md) to get set up 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) |