Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
Add lint writing documentation #3824
This adds a new documentation page that explains how to write Clippy
I plan to iterate a bit more on the prose of some sections, but I think the
One thing I'm not sure about: I felt like this is too big for CONTRIBUTING.md
Further things left to do:
This looks really good so far, thanks for doing this!!
As an aside: We should probably build a longer version of the lint naming conventions, we have a bunch of our own (like
flip1995 left a comment •
First off, thanks for the great work, this document will be really useful!
Maybe also mention the
In the future I would like a section "Advanced Lints", where some other useful things are mentioned and explained. I'm thinking of:
Or we can add additional documentation files for this, to keep this one short (which is probably the better idea)
Thanks for the reviews so far! I added a small TODO list to the PR description. I will fix those and give it another read/try later today.
These are all good ideas! I hope having the documentation in it's own directory lowers the bar a tiny bit for new documentation. I found that working with the existing CONTRIBUTING.md was getting a bit unpleasant.