Skip to content

Commit f346c8c

Browse files
committed
add caveat to the proposal requirements
1 parent 9b9fd6c commit f346c8c

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,14 @@ A proposal for a new lint rule in Ruff should include the following components:
233233
When choosing a diagnostic range (marked by `^^^^` above), also consider that the start of the
234234
range determines where `noqa` comments will be valid
235235

236+
It may be difficult to determine all of this information before attempting an implementation. In
237+
that case, the essential aspects of an initial rule request are:
238+
239+
- A proposed name
240+
- A proposed category (with the caveat that an ecosystem report helps to detect `pedantic` rules)
241+
- The first three sections of the rule documentation
242+
- An example diagnostic
243+
236244
#### Rule naming convention
237245

238246
Like Clippy, Ruff's rule names should make grammatical and logical sense when read as "allow

0 commit comments

Comments
 (0)