From 5100c562737878698d076c255d1503555a0de406 Mon Sep 17 00:00:00 2001
From: Evan Rittenhouse <evanrittenhouse@gmail.com>
Date: Tue, 4 Jul 2023 20:57:26 -0500
Subject: [PATCH] Add rule documentation template to `scripts/add_rule.py`
 (#5519)

---
 scripts/add_rule.py | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/scripts/add_rule.py b/scripts/add_rule.py
index 1fb271aa85..3e4c105822 100755
--- a/scripts/add_rule.py
+++ b/scripts/add_rule.py
@@ -98,6 +98,17 @@ use ruff_macros::{{derive_message_formats, violation}};
 
 use crate::checkers::ast::Checker;
 
+/// ## What it does
+///
+/// ## Why is this bad?
+///
+/// ## Example
+/// ```python
+/// ```
+///
+/// Use instead:
+/// ```python
+/// ```
 #[violation]
 pub struct {name};