Join GitHub today
GitHub is home to over 36 million developers working together to host and review code, manage projects, and build software together.Sign up
Configuration rules should be more conspicuous in the documentation #3074
Judging from my own usage since I switched to ESLint and subsequent behavior when looking up rule documentation, I think finding which rule one needs is the less troublesome part of the process, but what I tend to forget the most is what is the configuration ID. Incidentally, IMO this bit is probably the less conspicuous thing in all of the documentation.
This is a kind suggestion, please consider adding a direct link in the README to the following part in the docs:
Thanks for the issue! We get a lot of issues, so this message is automatically posted to each one to help you check that you've included all of the information we need to help you.
Reporting a bug? Please be sure to include:
Requesting a new rule? Please be sure to include:
Requesting a feature? Please be sure to include:
Including this information in your issue helps us to triage it and get you a response as quickly as possible.