Skip to content

Empty .nvmrc file at repo root, inconsistent documentation in various repo files #44438

@hesreallyhim

Description

@hesreallyhim

Code of Conduct

What article on docs.github.com is affected?

This appears to be a repository/tooling guidance inconsistency rather than a single end-user docs article. There is an empty .nvmrc file at the repo root. And there is a doc that mentions .node-version which is in .gitignore.

Relevant locations:

What changes are you suggesting?

Description:

Inconsistent documentation about Node setup across various docs. Empty .nvmrc file in this repo root. Makes it harder to contribute, although the package.json entry is clear enough, the .nvmrc file may lead a developer to invoke nvm use.

Current inconsistency:

  • .nvmrc exists but is empty.
  • src/codeql-cli/README.md says Node version is specified in .nvmrc.
  • .github/CONTRIBUTING.md references .node-version.
  • CI/setup and runtime checks use package.json (engines.node).

Suggested update:

  1. Update docs to reference package.json engines.node (or whichever source is intended).
  2. Update .github/CONTRIBUTING.md to reference the same canonical source.
  3. Either populate .nvmrc with an intended value or remove .nvmrc and any references to it.

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamtriageDo not begin working on this issue until triaged by the team

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions