rust-lang / rust-lang/rust-clippy
Provide a default config file for Clippy
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
We have a few lints with configuration values, like borrow_as_ptr. We want to increase the visibility of these config values, to encourage the use of them.
As part of this, we'd like to provide a default configuration file. The config should be included in the book.
Tasks:
- Examine config values and determine which are probably often used
- Some less commonly used but important ones should be listed, but commented out.
- Additionally, a configuration could be provided, that should be run once before a release with configs like:
avoid-breaking-exported-api
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
Start by reviewing Clippy's configurable lint values, including borrow_as_ptr, and the existing Clippy book. Identify commonly used settings, important less-common settings to comment out, and the release-oriented configuration containing avoid-breaking-exported-api. Done means the default configuration and release configuration are provided and documented in the book.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100