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 Linter vs ESLint in node.js api docs (fixes #14953) #14995

Merged
merged 4 commits into from Aug 31, 2021

Conversation

Brian-Bartels
Copy link
Contributor

@Brian-Bartels Brian-Bartels commented Aug 30, 2021

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)

Added a line under the Linter header to inform users of when they might be better off using the ESLint class

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

No

@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Aug 30, 2021
@eslint-github-bot
Copy link

eslint-github-bot bot commented Aug 30, 2021

Hi @Brian-Bartels!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

  • The commit message tag must be one of the following:

    The Tag is one of the following:

    • Fix - for a bug fix.
    • Update - either for a backwards-compatible enhancement or for a rule change that adds reported problems.
    • New - implements a new feature.
    • Breaking - for a backwards-incompatible enhancement or feature.
    • Docs - changes to documentation only.
    • Build - changes to build process only.
    • Upgrade - for a dependency upgrade.
    • Chore - for anything that isn't user-facing (for example, refactoring, adding tests, etc.).

    You can use the labels of the issue you are working on to determine the best tag.

  • There should be a space following the initial tag and colon, for example 'New: Message'.

Read more about contributing to ESLint here

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Aug 30, 2021

CLA Signed

The committers are authorized under a signed CLA.

@Brian-Bartels Brian-Bartels changed the title Clarify Linter vs ESLint in node.js api docs Docs: Clarify Linter vs ESLint in node.js api docs (fixes #14953) Aug 30, 2021
@nzakas nzakas added accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon labels Aug 31, 2021
@nzakas nzakas linked an issue Aug 31, 2021 that may be closed by this pull request
docs/developer-guide/nodejs-api.md Outdated Show resolved Hide resolved
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Aug 31, 2021

CLA Signed

The committers are authorized under a signed CLA.

nzakas
nzakas approved these changes Aug 31, 2021
Copy link
Member

@nzakas nzakas left a comment

LGTM. Thanks!

@nzakas nzakas merged commit 4165c7f into eslint:master Aug 31, 2021
13 checks passed
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Feb 28, 2022
@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 Feb 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Clarify Linter vs ESLint in node.js api docs
2 participants