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

Docs: Clarify package.json requirement in Getting Started (refs #13549) #13696

Merged
merged 2 commits into from Sep 22, 2020

Conversation

nzakas
Copy link
Member

@nzakas nzakas commented Sep 16, 2020

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

Clarifies that a package.json file is necessary to use --init in the Getting Started guide. (it errors currently when there is no package.json file present)

Is there anything you'd like reviewers to focus on?

Is this clear enough?

@nzakas nzakas added documentation Relates to ESLint's documentation evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion labels Sep 16, 2020
Copy link
Member

@mdjermanovic mdjermanovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@nzakas nzakas merged commit 30b76c9 into master Sep 22, 2020
@nzakas nzakas deleted the getting-started-update branch September 22, 2020 00:47
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Mar 22, 2021
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Mar 22, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants