-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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
[Doc] Make the background section concise and improve its formality #18928
Conversation
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.
Thanks for the contribution! I left a couple of comments, but other than that LGTM
doc/guides/maintaining-V8.md
Outdated
for maintaining the V8 branches in Node.js LTS and Current releases and how the | ||
Node.js and V8 teams at Google can help. | ||
different compared to the support horizon for Node.js. As a result, Node.js | ||
needs to support a version of V8 longer than what upstream needs to support. |
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 think we can change a version
with versions
or multiple versions
since we support one version of V8 for each release line.
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.
Thanks for pointing out. I will revise it:)
doc/guides/maintaining-V8.md
Outdated
LTS supported branch. | ||
|
||
This document attempts to outline the current maintaining processes, proposes | ||
a workflow for maintaining the V8 branches in both Node.js LTS and current releases, and |
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.
Could you be so kind and wrap this paragraph at 80 characters?
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.
Could you specify how can I achieve this without losing information. Also, I think this paragraph can be removed since the sections discussed in the paragraph were already explicitly stated in the document.
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.
Sorry, I meant wrap every line in the paragraph at 80 characters. Otherwise, our linter will complain :)
This document attempts to outline the current maintaining processes, proposes
a workflow for maintaining the V8 branches in both Node.js LTS and current
releases, and discusses how the Node.js and V8 teams at Google can help.
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.
Sure, I will fix this. Sorry for the confusion and thank you again.
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.
LGTM, just a tiny nit: commit message doesn't fit the guidelines
doc/guides/maintaining-V8.md
Outdated
to support. V8 branches in Node.js lack of official maintaining process due | ||
to a missing LTS supported branch. | ||
|
||
This document attempts to outline the current maintaining processes, proposes |
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.
Nit: maintenance processes
seems more natural to me than maintaining processes
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.
Agreed and fixed. thanks:)
Hello @claudiorodriguez, I just uploaded a new commit to address the incorrect commit message format. Please let me know if I am still doing it wrong. thanks |
Landed in a27e6d7, thanks! 😄 |
PR-URL: #18928 Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: nodejs#18928 Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: nodejs#18928 Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
PR-URL: nodejs#18928 Reviewed-By: Claudio Rodriguez <cjrodr@yahoo.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Improve the writing quality of the background section in maintaining-V8.md