Repository navigation
Add a migration guide for categories - #28087
Merged
Merged
Conversation
ntBre
added
the
documentation
ntBre
force-pushed
the
brent/category-migration
branch
from
August 26, 2026 22:56
b53791e to
00a4b47
Compare
|
ntBre
force-pushed
the
brent/category-migration
branch
from
August 26, 2026 23:10
00a4b47 to
814d90b
Compare
ntBre
marked this pull request as ready for review
August 26, 2026 23:20
This comment was marked as resolved.
This comment was marked as resolved.
chirizxc
reviewed
Aug 27, 2026
This comment was marked as resolved.
This comment was marked as resolved.
MichaReiser
reviewed
Aug 27, 2026
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
ntBre
changed the title
ntBre
commented
Aug 27, 2026
ntBre
force-pushed
the
brent/codeless-rules
branch
from
August 27, 2026 13:07
9c5afd2 to
d8e40ef
Compare
ntBre
force-pushed
the
brent/category-migration
branch
from
August 27, 2026 13:07
24b9253 to
13d667c
Compare
ntBre
force-pushed
the
brent/codeless-rules
branch
from
August 27, 2026 13:20
d8e40ef to
1596c5a
Compare
ntBre
force-pushed
the
brent/category-migration
branch
2 times, most recently
from
August 27, 2026 14:07
128832f to
590e5f0
Compare
ntBre
force-pushed
the
brent/category-migration
branch
from
August 27, 2026 15:26
590e5f0 to
f7521e2
Compare
MichaReiser
reviewed
Aug 27, 2026
MichaReiser
left a comment
MichaReiser
left a comment
Member
There was a problem hiding this comment.
I left a few initial comments, haven't done a full review yet
Summary
--
As the title says, this PR adds two new pages to our documentation: a variant of our Rules page
organized by the new categories and a migration guide explaining how to approach a migration to the
new categories. I initially planned to avoid including any kind of automated migration tool, but I
ended up writing a relatively simple Python script for automating a 1:1 migration. It actually seems
pretty helpful because it:
- selects categories to cover your existing rules fully
- adds ignores to eliminate extra rules from the full categories
- includes `# category` headings to help identify rules you might want to add
Some example output from the Ruff repo:
```toml
select = [
"correctness",
"suspicious",
"complexity",
"performance",
"style",
"security",
"formatting",
"pedantic",
"restriction",
]
ignore = [
# correctness
"airflow3-dag-dynamic-value",
"assert-on-string-literal",
"await-outside-async",
"bad-open-mode",
"bad-str-strip-call",
"bad-string-format-character",
"bad-string-format-type",
"continue-in-finally",
"debugger",
"direct-logger-instantiation",
"duplicate-bases",
"future-required-type-annotation",
"global-at-module-level",
"incorrect-decorator-order",
"indented-form-feed",
"invalid-all-format",
# ...
]
```
Test Plan
--
Future readers :D
Co-authored-by: Brent Westbrook <36778786+ntBre@users.noreply.github.com>
ntBre
force-pushed
the
brent/category-migration
branch
from
September 17, 2026 20:46
85fba7a to
72cb40f
Compare
ntBre
commented
Sep 17, 2026
ntBre
force-pushed
the
brent/category-migration
branch
from
September 17, 2026 21:01
72cb40f to
083a241
Compare
ntBre
marked this pull request as ready for review
September 17, 2026 21:02
MichaReiser
reviewed
Sep 28, 2026
MichaReiser
left a comment
MichaReiser
left a comment
Member
There was a problem hiding this comment.
A few more comments. I think we mainly need to align on how seriously we're considering deprecating linter groups.
MichaReiser
approved these changes
Sep 30, 2026
MichaReiser
left a comment
MichaReiser
left a comment
Member
There was a problem hiding this comment.
Thank you, this is great. You're a strong writer
Co-authored-by: Micha Reiser <micha@reiser.io>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
As the title says, this PR extends our category docs to include a migration guide explaining how to approach a migration to the new categories. Initially I included a migration script and a description of how it works, but if we're unlikely to remove linter groups, it seems less helpful. Our recommendation is basically to
extend-selectthe new categories to round out your existing configuration, and no dramatic migration is necessary.I guess this is not really a "migration guide" anymore, as reflected in the updated section title.