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.

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

docs: fix Node req in develop README section #655

Closed
wants to merge 1 commit into from
Closed

docs: fix Node req in develop README section #655

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,10 +235,10 @@ A few advantages of this solution:

## Develop

1. Make sure you are using Node.js 14 or higher and npm 7 or higher
1. Write code and tests.
1. Make sure all tests pass `npm test`
1. Make sure code is well formatted and secure `npm run lint`
1. Make sure you are using Node.js 15 or higher and npm 7 or higher.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
1. Make sure you are using Node.js 15 or higher and npm 7 or higher.
1. Make sure you are using Node.js 16 or higher and npm 7 or higher.

15 has only 0.5 year of support, 16 has 2 years.

Copy link
Member

Choose a reason for hiding this comment

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

does it mean we drop support for Node 14? isn't it a breaking change?

Copy link
Member

Choose a reason for hiding this comment

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

On the one hand it is, but on the other it is not. You can always have node 14 but npm in 7 version - you have to install npm manually.

Copy link
Member

Choose a reason for hiding this comment

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

So a breaking change yes 😄

Copy link
Member Author

Choose a reason for hiding this comment

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

Would it make sense to release this in the 2.0 version of the parser then? We could say "we support >=16 but it might work in older versions" kinda message.

2. Write code and tests.
3. Make sure all tests pass `npm test`.
4. Make sure code is well formatted and secure `npm run lint`.

Release regenerates API documentation and browser bundle, so you do not have to regenerate it manually with `npm run docs` and `npm run prepublishOnly`.

Expand Down