Hey Anton, Thanks for your interest. To answer your questions:
1. A "new user" is someone who is using ESLint for the first time. 2. We would like the guide to at least cover these topics, but I think it can be ongoing discussion as to what we should include. 3. I don't think we have strong opinions about this at this point. The goal is to make it easier for new users to get started using ESLint. 4. Ideally, the user guide would help someone get off the ground and using the tool. It would be great to link to further configuration, should the user desire, but I think the getting started guide should be a complete guide in and of itself. Feedback on the suggested ideas: 1. Can you expand on what you're envisioning? The getting started guide would ideally be as simple as possible. ESLint's configuration can be very complex and overwhelming, and we want to make onboarding friendly and succinct. 2. This sounds overwhelming to a new user. Since we have a rules page <https://eslint.org/docs/rules/> that users can peruse at their leisure, this doesn't seem particularly helpful. 3. We already do this. 4. Can you explain what p. 4-6 is referring to here? 5. Can you explain what you mean by this? Take care! Kai On Wed, May 13, 2020 at 10:54 AM Anton Zolotukhin <[email protected]> wrote: > Hello, > I would like to work on this project during the GSOD 2020. There are > several questions I have in mind right now: > > 1. Who is considered as a "new user" in terms of the guide? > 2. Is this a complete list > <https://github.com/eslint/eslint/issues/13130#issuecomment-614916040> > of details that you want to see in the new guide? In other words, is this > all you want the new user to know after reading the guide? > 3. Do you want to have a guide with all the points described in one > page or this should be a series of step-by-step guides? > 4. What would be the next step(s) of the new user after reading the > guide? Probably, deeper configuration (See p.3 in my ideas below) > > My ideas: > > 1. Create the guide with gradual complexity (from simplest ever config > to a more advanced) > 2. Describe what default rules will be added to the config after > typing eslint --init and why these rules are important > 3. Categorize all the rules based on some properties to simplify > search and selection of the desired rule(s) > 4. Add examples to p. 4-6 in the form of JS code samples to > demonstrate different states (like before/after fixes) > 5. Change the page template to show the updated content flawlessly > > Some feedback is highly appreciated. > > -- > You received this message because you are subscribed to the Google Groups > "ESLint" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/eslint/b9b30bb7-11e4-4d87-b48b-2a342362ba40%40googlegroups.com > <https://groups.google.com/d/msgid/eslint/b9b30bb7-11e4-4d87-b48b-2a342362ba40%40googlegroups.com?utm_medium=email&utm_source=footer> > . > -- Kai Cataldo Independent Software Developer & maintainer of ESLint <https://eslint.org/> and Babel <https://babeljs.io/> kaicataldo.com -- You received this message because you are subscribed to the Google Groups "ESLint" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/eslint/CAKfCaPjAKbzb4bZ7-OdmesDHjt3cdnpmNfXimQ1fuohN7QtNkw%40mail.gmail.com.
