From dc9a08fc78147cdd3c08bcb843162945c1708536 Mon Sep 17 00:00:00 2001
From: llogiq <bogusandre@gmail.com>
Date: Mon, 14 Dec 2015 22:23:33 +0100
Subject: [PATCH] Add short section on lint docs

---
 CONTRIBUTING.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index eebea413f0d..5147595ab54 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -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.