rust-lang / rust-lang/rust-clippy
[Roadmap] Improve Clippy documentation
Open
Nobody has claimed this yet.
A-documentation
C-tracking-issue
P-medium
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
Similar to a Clippy Book, which describes how to use Clippy, a book about how to
contribute to Clippy might be helpful for new and existing contributors. There's
already the doc directory in the Clippy repo, this can be turned into a
mdbook.
#6011
Steps to completion:
- Write a Clippy book explaining its features and how to use it https://doc.rust-lang.org/nightly/clippy/
- Convert the contributor documentation to a book (partly done)
- Update dev part of book with feedback from contributors
- Add book to docs.rs drop down
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 inspecting the existing doc directory and the Clippy book linked in the issue, then review the contributor documentation and the partly completed mdBook conversion. Done means the contributor documentation is available as a book and its development section reflects contributor feedback, with the listed roadmap items updated accordingly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100