Skip to content

Conversation

@SwetaTanwar
Copy link

Prerequisites checklist

What is the purpose of this pull request?

To have the required node version specified in the README.md

What changes did you make? (Give an overview)

Updated README.md Installation section to specify the node version required.

Related Issues

Fixes eslint/eslint#20243

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

@github-project-automation github-project-automation bot moved this to Needs Triage in Triage Nov 18, 2025
@eslint-github-bot
Copy link

Hi @SwetaTanwar!, thanks for the Pull Request

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

  • The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

@SwetaTanwar SwetaTanwar self-assigned this Nov 18, 2025
@SwetaTanwar SwetaTanwar changed the title doc: update readme to include node version docs: update readme to include node version Nov 18, 2025
@eslint-github-bot eslint-github-bot bot added the documentation Improvements or additions to documentation label Nov 18, 2025
@nzakas
Copy link
Member

nzakas commented Nov 18, 2025

Thanks for taking a look at this. We generally don't include required Node.js versions in the README because it requires manual updating whenever that changes (easy to forget). I think it's okay to rely on what's listed in package.json and let the npm CLI do the work for us there. What do you think?

@nzakas nzakas moved this from Needs Triage to Triaging in Triage Nov 18, 2025
@SwetaTanwar
Copy link
Author

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 like https://github.com/eslint/rewrite, https://github.com/eslint/json, etc don't have.

I feel there should be parity among all the repos of eslint, either we mention node version in README or we don't at all.

@nzakas
Copy link
Member

nzakas commented Nov 19, 2025

Yeah, we do for eslint because it's a CLI and the Node.js version is important. generator-eslint was generated from a template for Yeoman that included that information from the default.

For the other packages, it really doesn't matter and I don't like getting stuck needing to manually update READMEs everywhere.

@lumirlumir
Copy link
Member

lumirlumir commented Nov 27, 2025

Appreciate for your work on this, but per the consensus in eslint/eslint#20243 (comment), I'm kindly closing this PR.

@lumirlumir lumirlumir closed this Nov 27, 2025
@github-project-automation github-project-automation bot moved this from Triaging to Complete in Triage Nov 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Complete

Development

Successfully merging this pull request may close these issues.

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

4 participants