Mirrors/rust-clippy
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-clippy synced 2024-09-20 14:41:58 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add short section on lint docs

Browse source
This commit is contained in:
llogiq 2015-12-14 22:23:33 +01:00
parent c645a9febe
commit dc9a08fc78
1 changed files with 13 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
CONTRIBUTING.md
View file

@ -40,6 +40,19 @@ contains some questionable code itself! Also before making a pull request, pleas
`util/update_lints.py`, which will update `lib.rs` and `README.md` with the lint declarations. Our
travis build actually checks for this.
Also please document your lint with a doc comment akin to the following:
```
/// **What it does:** Describe what the lint matches.
///
/// **Why is this bad?** Write the reason for linting the code.
///
/// **Known problems:** Hopefully none.
///
/// **Example:** Insert a short example if you have one
```
Our `util/update_wiki.py` script can then add your ilnt docs to the wiki.
## Contributions
Clippy welcomes contributions from everyone.