rust-lang / rust-lang/rust-clippy
"newbie mode" that contains helpful hints that don't work as lints
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
It would be interesting to have a "newbie mode" (basically another lint group) that points out various features in your code, not necessarily suggesting fixes or anything.
For example impl Trait for OtherTrait can explain the difference between impl<T: OtherTrait> Trait for T and itself" or fn foo(mut x: Bar) can tell you that mut x does not mutate the outer variable when Bar is copy. Stuff like this, that doesn't work well as a lint (because there are plenty of good reasons to do it), but do merit a "watch out this may not do what you think" for newbies.
Thoughts? Ideas for similar newbie hint-lints?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files, tests, or entry points are named. Start by reviewing the proposed newbie mode and its example hints, then establish the scope, behavior, and completion criteria for a separate lint group.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100