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.

Sign up for GitHub

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

Jump to bottom

Improve the examples for the lints #2

Open
PurpleBooth opened this issue Oct 1, 2021 · 0 comments
Open

Improve the examples for the lints #2

PurpleBooth opened this issue Oct 1, 2021 · 0 comments
Labels
hacktoberfest

Comments

@PurpleBooth
Copy link
Owner

Developer experience is key to the usage of the tool. I am not always amazing at creating good documentation, and I think the examples in this repository leave a lot to be desired.

In particular:

  • Each lint shoud have a positive and negative examples
  • There should be an explanation as to why this is important and it should match what is in the errors in each lint
  • There should be some exploration of any gotchas or limitations in the lints
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
hacktoberfest
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@PurpleBooth