-
-
Notifications
You must be signed in to change notification settings - Fork 34.5k
doc: remove v prefix for Node.js with version references #61488
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.
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
base: main
Are you sure you want to change the base?
Conversation
|
Review requested:
|
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
sxa
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I personally think it looks better with the v even in these situations, although I appreciate that it was added some time ago.
I did wonder if this recommendation was made around the time of Node 8 where there could easily be confusion with our V8 dependency but looks like it was done by @Trott around Node 15 #33755
Not sure I care to much to object though but I felt it was worth voicing my opinion especially since it does mean we have some inconsistencies between how we'll write it in some places and others which have the full version (changelogs, tarball names). Seems like something that will be easy to trip up on because of that.
|
This only concerns writing the version in the form like For example the following is OK:
The Node.js documentation style guide > Version references section needs to be extended to describe these two situations clearly. The original authors and reviewers of the style guide section considered the examples I quoted above to be "non-prose" and therefore exempt. I plan to submit a proposal for a style guide update soon. I'm waiting for #61471 to be resolved, as currently the API docs website presentation of the Node.js version is not conformant with the style guide. I personally tripped up on this when I submitted a PR that needed to describe a version (corrected in this PR for |
There is the V8 dependency, yes, but also the built-in I don't have an opinion on whether this makes sense anymore or not. And in fact, I'd defer to the communications professionals in the OpenJS Foundation about what format to use to specify Node.js versions in text. @nodejs/openjs |
Situation
According to the Node.js documentation style guide > Version references section, version references using the text "Node.js" should be written without a v prefix.
Change
Change occurrences of Node.js version references to conform to the style guide, for example:
Usage in CHANGELOG files is not touched, since these are considered immutable historical records.
doc/contributing/releases.md is also left unchanged. This should preferably be reviewed and updated separately by the release team to check and correct usage of "Node.js v" consistently.
Edit for clarification: This PR is only concerned with the combination text such as "Node.js 24.13.0".
Other uses with v like the output of the CLI command
node --version"v24.13.0" or API documentation "Added in: v24.13.0" are OK and not impacted.This is also in line with blog post release notices on https://nodejs.org/en/blog/release