Skip to content

Commit

Permalink
DOC(README): rule code assignment policy (#72)
Browse files Browse the repository at this point in the history
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?
  • Loading branch information
sbrugman authored Sep 13, 2024
1 parent af3c6ff commit aef3ea1
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,16 @@ To enable them, use standard flake8 configuration options for the plugin mode or
If you encounter a bug or some other problem with TorchFix, please file an issue on
https://github.com/pytorch-labs/torchfix/issues.

## Rule Code Assignment Policy

New rule codes are assigned incrementally across the following categories:

* **TOR0XX, TOR1XX**: General-purpose `torch` functionality.
* **TOR2XX**: Domain-specific rules, such as TorchVision.
* **TOR4XX**: Noisy rules that are disabled by default.
* **TOR9XX**: Internal rules specific for `pytorch/pytorch` repo, other users should not use these.

TOR0, TOR1 and TOR2 are enabled by default.

## Rules

Expand Down

0 comments on commit aef3ea1

Please sign in to comment.