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

Create documentation with details on each rule #60

Closed
rgeyer opened this issue May 25, 2022 · 0 comments
Closed

Create documentation with details on each rule #60

rgeyer opened this issue May 25, 2022 · 0 comments

Comments

@rgeyer
Copy link
Collaborator

rgeyer commented May 25, 2022

Currently, each rule is very tersely described. Each rule should have a longer one-pager to describe "why" the rule exists, and what best practice it enforces or encourages.

This information will be useful for consumers when deciding when/if they should exclude a given rule, and serve as the canonical manual of best practices.

@rgeyer rgeyer closed this as completed in fab2526 Sep 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant