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:
- Update docs to reference
package.json engines.node (or whichever source is intended).
- Update
.github/CONTRIBUTING.md to reference the same canonical source.
- Either populate
.nvmrc with an intended value or remove .nvmrc and any references to it.
Additional information
No response
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
.nvmrcfile at the repo root. And there is a doc that mentions.node-versionwhich is in.gitignore.Relevant locations:
What changes are you suggesting?
Description:
Inconsistent documentation about Node setup across various docs. Empty
.nvmrcfile in this repo root. Makes it harder to contribute, although thepackage.jsonentry is clear enough, the.nvmrcfile may lead a developer to invokenvm use.Current inconsistency:
.nvmrcexists but is empty.src/codeql-cli/README.mdsays Node version is specified in.nvmrc..github/CONTRIBUTING.mdreferences.node-version.package.json(engines.node).Suggested update:
package.jsonengines.node(or whichever source is intended)..github/CONTRIBUTING.mdto reference the same canonical source..nvmrcwith an intended value or remove.nvmrcand any references to it.Additional information
No response