Skip to content

Commit f21d6ce

Browse files
committed
docs(checks): add technical requirements
1 parent 459280e commit f21d6ce

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/checks.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,15 @@ consistent, we use a standard set of terms.
1818

1919
## Technical Requirements
2020

21+
Checks can be rather cumbersome, particularly in large volumes. To combat this,
22+
we have devised a set of implementation requirements:
23+
24+
- Checks with more than 150 entries should be batched into chunks of 150
25+
- Checks with more than 50 entries should have their contents factored out into
26+
a separate file, formatted as a CSV and bearing the same name as the last
27+
element of the check path. For example, `cliches.misc.write_good` has the
28+
associated file `write-good`
29+
2130
## Suitability
2231

2332
It is difficult to ensure Proselint's catalog of checks remains both tidy and

0 commit comments

Comments
 (0)