d8e76ecaf1
Modify lint pass note for consistency with the book This PR: - removes the note which appears when an early lint pass is created using `cargo dev new_lint`. - adds a note that encourages contributors to use an early pass unless type information is needed if a late lint pass is created using `cargo dev new_lint`. Late pass remains the default value if no pass is specified as most lints use late pass. Closes #12595 changelog: none |
||
|---|---|---|
| .. | ||
| infrastructure | ||
| proposals | ||
| adding_lints.md | ||
| basics.md | ||
| common_tools_writing_lints.md | ||
| defining_lints.md | ||
| emitting_lints.md | ||
| lint_passes.md | ||
| macro_expansions.md | ||
| method_checking.md | ||
| README.md | ||
| speedtest.md | ||
| the_team.md | ||
| trait_checking.md | ||
| type_checking.md | ||
| writing_tests.md | ||
Clippy Development
Hello fellow Rustacean! If you made it here, you're probably interested in making Clippy better by contributing to it. In that case, welcome to the project!
Note: If you're just interested in using Clippy, there's nothing to see from this point onward, and you should return to one of the earlier chapters.
Getting started
If this is your first time contributing to Clippy, you should first read the Basics docs. This will explain the basics on how to get the source code and how to compile and test the code.
Additional Readings for Beginners
If a dear reader of this documentation has never taken a class on compilers and interpreters, it might be confusing as to why AST level deals with only the language's syntax. And some readers might not even understand what lexing, parsing, and AST mean.
This documentation serves by no means as a crash course on compilers or language design. And for details specifically related to Rust, the Rustc Development Guide is a far better choice to peruse.
The Syntax and AST chapter and the High-Level IR chapter are great introduction to the concepts mentioned in this chapter.
Some readers might also find the introductory chapter of Robert Nystrom's Crafting Interpreters a helpful overview of compiled and interpreted languages before jumping back to the Rustc guide.
Writing code
If you have done the basic setup, it's time to start hacking.
The Adding lints chapter is a walk through on how to add a new lint to Clippy. This is also interesting if you just want to fix a lint, because it also covers how to test lints and gives an overview of the bigger picture.
If you want to add a new lint or change existing ones apart from bugfixing, it's also a good idea to give the stability guarantees and lint categories sections of the Clippy 1.0 RFC a quick read. The lint categories are also described earlier in this book.
Note: Some higher level things about contributing to Clippy are still covered in the
CONTRIBUTING.mddocument. Some of those will be moved to the book over time, like:
- Finding something to fix
- IDE setup
- High level overview on how Clippy works
- Triage procedure
- Bors and Homu