Update contributing guide for adding a new rule#22779
Merged
Conversation
amyreese
approved these changes
Jan 21, 2026
MichaReiser
reviewed
Jan 21, 2026
CONTRIBUTING.md
Outdated
| @@ -187,7 +189,8 @@ defined therein is a Python AST visitor, which iterates over the AST, building u | |||
| and calling out to lint rule analyzer functions as it goes. | |||
|
|
|||
| If you need to inspect the AST, you can run `cargo dev print-ast` with a Python file. Grep | |||
Member
There was a problem hiding this comment.
Very unrelated, but our playground might be more approachable than the CLI :) We could add a link to https://play.ruff.rs/?secondary=AST
MichaReiser
approved these changes
Jan 21, 2026
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
3 participants
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
This is a follow-up to #21035 and #22732 to update the contribution guide for
adding a new rule for the changes to the
violation_metadataattribute and alsoto how we emit diagnostics.
Test Plan
Built and viewed the docs locally to make sure they render correctly