Skip to content

Commit aef3ea1

Browse files
authored
DOC(README): rule code assignment policy (#72)
The documentation should explain the rule code assignment policy, so that its clear which code to pick for newly developed rules. This was my best guess from the existing rules. Is it correct?
1 parent af3c6ff commit aef3ea1

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,16 @@ To enable them, use standard flake8 configuration options for the plugin mode or
5353
If you encounter a bug or some other problem with TorchFix, please file an issue on
5454
https://github.com/pytorch-labs/torchfix/issues.
5555

56+
## Rule Code Assignment Policy
57+
58+
New rule codes are assigned incrementally across the following categories:
59+
60+
* **TOR0XX, TOR1XX**: General-purpose `torch` functionality.
61+
* **TOR2XX**: Domain-specific rules, such as TorchVision.
62+
* **TOR4XX**: Noisy rules that are disabled by default.
63+
* **TOR9XX**: Internal rules specific for `pytorch/pytorch` repo, other users should not use these.
64+
65+
TOR0, TOR1 and TOR2 are enabled by default.
5666

5767
## Rules
5868

0 commit comments

Comments
 (0)