Skip to content
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.

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

Add documentation for how to create a community rule #898

Open
mnojek opened this issue Jun 29, 2023 · 0 comments
Open

Add documentation for how to create a community rule #898

mnojek opened this issue Jun 29, 2023 · 0 comments
Labels
community rules Related to community rules documentation Improvements or additions to documentation

Comments

@mnojek
Copy link
Member

mnojek commented Jun 29, 2023

Since we want the users to contribute more and the community rules themselves, we need to provide a good instruction that explains this process step-by-step. It should contain instructions:

  • what files need to be created and where should be placed
  • how to name the rule, provide proper ID and assign proper severity
  • how to implement the logic in Python and how to traverse AST tree (especially explain how generic_visit and super().visit_File() work)
  • ...?

Maybe we can provide a command to generate a template for a new rule?

This task is part of the #809 issue.

@mnojek mnojek added community rules Related to community rules documentation Improvements or additions to documentation labels Jun 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community rules Related to community rules documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant