Skip to content

Docs: Add/Update required node version in the README.md #20243

@SwetaTanwar

Description

@SwetaTanwar

Docs page(s)

https://github.com/eslint/rewrite

https://github.com/eslint/json/blob/main/README.md

https://github.com/eslint/js

https://github.com/eslint/json/blob/main/README.md

https://github.com/eslint/css/blob/main/README.md

https://github.com/eslint/csstree/blob/main/README.md

https://github.com/eslint/markdown/blob/main/README.md

https://github.com/eslint/config-inspector/blob/main/README.md

What documentation issue do you want to solve?

For now, few packages like https://github.com/eslint/eslint/, https://github.com/eslint/generator-eslint, etc have their node prerequisites mentioned in their README.md, but majority of the repos don't have.

What do you think is the correct solution?

Few solutions which I can think of:

  1. Update the README.md in all the repos to follow a similar pattern where each will have a prerequisite section for node.
  2. Standardise the node prerequisite just like being done for Sponsors section, which will allow us to do the change in 1 repo and fetch it in all README.md but the catch which I see here is this would mean to add a dedicated required node version section, not prerequiste section

Participation

  • I am willing to submit a pull request for this change.

Additional comments

No response

Metadata

Metadata

Assignees

Labels

documentationRelates to ESLint's documentation

Type

No type

Projects

Status

Evaluating

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions