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

Configuration rules should be more conspicuous in the documentation #3074

Closed
ghost opened this issue Jul 19, 2015 · 4 comments

Comments

Projects
None yet
4 participants
@ghost
Copy link

commented Jul 19, 2015

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:

Configuring Rules

  • 0 - turn the rule off
  • 1 - turn the rule on as a warning (doesn't affect exit code)
  • 2 - turn the rule on as an error (exit code will be 1)
@eslintbot

This comment has been minimized.

Copy link

commented Jul 19, 2015

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:

  1. The version of ESLint you are using (run eslint -v)
  2. The source code that caused the problem
  3. The configuration you're using (for the rule or your entire config file)
  4. The actual ESLint output complete with line numbers

Requesting a new rule? Please be sure to include:

  1. The use case for the rule - what is it trying to prevent or flag?
  2. Whether the rule is trying to prevent an error or is purely stylistic
  3. Why you believe this rule is generic enough to be included

Requesting a feature? Please be sure to include:

  1. The problem you want to solve (don't mention the solution)
  2. Your take on the correct solution to problem

Including this information in your issue helps us to triage it and get you a response as quickly as possible.

Thanks!

@ilyavolodin ilyavolodin added the triage label Jul 19, 2015

@mysticatea

This comment has been minimized.

Copy link
Member

commented Jul 19, 2015

I agree, the part is very important but hard to find.

@nzakas

This comment has been minimized.

Copy link
Member

commented Jul 21, 2015

Working on this

@nzakas nzakas closed this in 36ceb9d Jul 22, 2015

nzakas added a commit that referenced this issue Jul 22, 2015

Merge pull request #3108 from eslint/issue3074
Docs: Add config information to README (fixes #3074)
@ghost

This comment has been minimized.

Copy link
Author

commented Jul 22, 2015

👍 Thank you.

@eslint eslint bot locked and limited conversation to collaborators Feb 7, 2018

@eslint eslint bot added the archived due to age label Feb 7, 2018

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
You can’t perform that action at this time.