Add contributor guide for writing custom PySpector rules #19
Conversation
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
added sections in readme
ParzivalHack
requested changes
Jan 10, 2026
Owner
There was a problem hiding this comment.
Hey, thanks for the PR. The initial content of it looks good, but the code example you made, doesn't reflect PySpector's real static/AST rules pattern. Please change the example you made at the end and also i think this documentation enhancement looks better in the CONTRIBUTING.md rather than in the README.md
Thanks again for your help, we appreciate it :)
ParzivalHack
added
documentation
Owner
|
@Chidwan3578 for guidance, here you can find a commit from a previous contribution, showing the pattern used by PySpector, for static rules :) |
I have refined the documentation around custom rule creation by moving the “Writing Custom Rules” section from README.md to CONTRIBUTING.md, where it’s more appropriate for contributors. It also updates the example to match PySpector’s actual TOML-based static/AST rule pattern, ensuring the guidance reflects how rules are really defined in the project based on the previous linked commit. :)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
added sections in readme