Skip to content

docs: include npm install instructions in getting started #2120

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 30, 2020
Merged

docs: include npm install instructions in getting started #2120

merged 2 commits into from
May 30, 2020

Conversation

Robbie-Cook
Copy link
Contributor

This PR adds NPM commands for installing and running typescript-eslint with the NPM package manager.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @Robbie-Cook!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

@codecov
Copy link

codecov bot commented May 28, 2020 •
edited
Loading

Codecov Report

Merging #2120 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #2120   +/-   ##
=======================================
  Coverage   93.42%   93.42%           
=======================================
  Files         171      171           
  Lines        7755     7755           
  Branches     2215     2215           
=======================================
  Hits         7245     7245           
  Misses        244      244           
  Partials      266      266
Flag Coverage Δ
#unittest 93.42% <ø> (ø)

@Robbie-Cook Robbie-Cook changed the title Included NPM instructions in Getting Started docs(eslint-plugin) Included NPM instructions in Getting Started May 29, 2020
@bradzacher bradzacher added the documentation Documentation ("docs") that needs adding/updating label May 29, 2020
@bradzacher bradzacher changed the title docs(eslint-plugin) Included NPM instructions in Getting Started docs(eslint-plugin): include npm install instructions in getting started May 29, 2020
bradzacher
bradzacher requested changes May 29, 2020
View reviewed changes
Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

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

Thanks - one typo though

@bradzacher bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label May 29, 2020
@Robbie-Cook @bradzacher
Update docs/getting-started/linting/README.md
ce93485 
Co-authored-by: Brad Zacher <brad.zacher@gmail.com>
@Robbie-Cook
Copy link
Contributor Author

Hey @bradzacher , I have applied the suggestion. Sorry about that, I should have caught that.

@bradzacher bradzacher removed the awaiting response Issues waiting for a reply from the OP or another party label May 30, 2020
bradzacher
bradzacher approved these changes May 30, 2020
View reviewed changes
Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

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

thanks!

@bradzacher bradzacher changed the title docs(eslint-plugin): include npm install instructions in getting started docs: include npm install instructions in getting started May 30, 2020
@bradzacher bradzacher merged commit dc061ed into typescript-eslint:master May 30, 2020
@Robbie-Cook Robbie-Cook deleted the patch-1 branch May 31, 2020 08:21
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 1, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@bradzacher bradzacher bradzacher approved these changes

Assignees
No one assigned
Labels
documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Robbie-Cook @bradzacher