Skip to content

DOC(README): rule code assignment policy #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 13, 2024
Merged

DOC(README): rule code assignment policy #72

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
16e4d7b
DOC(README): rule code assignment policy
sbrugman Sep 4, 2024
4b1667f
Distinguish errors and warnings
sbrugman Sep 4, 2024
734fc10
docs(README): update rule code assignment policy
sbrugman Sep 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
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