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] The getting started docs for running lint is incorrect #1834

Closed
MSNev opened this issue Jan 15, 2021 · 4 comments
Closed

[Docs] The getting started docs for running lint is incorrect #1834

MSNev opened this issue Jan 15, 2021 · 4 comments
Assignees
Labels
bug Something isn't working document Documentation-related good first issue Good for newcomers

Comments

@MSNev
Copy link
Contributor

MSNev commented Jan 15, 2021

The Contributing.md defines that it's possible to "lint" all of the modules by running

npm lint

However, using NPM 6.14.8 this produces

> npm lint

Usage: npm <command>

where <command> is one of:
    access, adduser, audit, bin, bugs, c, cache, ci, cit,

... <Pruned> ...

Did you mean one of these?
    link
    list
    ping

The correct command appears to be

npm run lint

@MSNev MSNev added the bug Something isn't working label Jan 15, 2021
@dyladan dyladan added document Documentation-related good first issue Good for newcomers up-for-grabs Good for taking. Extra help will be provided by maintainers labels Jan 15, 2021
@drexler
Copy link
Contributor

drexler commented Jan 20, 2021

I'll take this to get started. I also noticed that the changelog script command is missing from the package.json as well although it's specified in CONTRIBUTING.md. @MSNev should I fold that in here or rather have it as separate issue/PR?

@MSNev
Copy link
Contributor Author

MSNev commented Jan 20, 2021

I don't have an issue with that @dyladan to confirm

@obecny obecny removed the up-for-grabs Good for taking. Extra help will be provided by maintainers label Jan 21, 2021
@cloudbring
Copy link

This issue seems solved as per #1858 by @drexler which is already merged.
Should we close this?

@MSNev
Copy link
Contributor Author

MSNev commented Mar 10, 2021

Yep, I believe this is now fixed

@MSNev MSNev closed this as completed Mar 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working document Documentation-related good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

5 participants