doc: add LTS info to COLLABORATOR_GUIDE.md #3442
Conversation
| #### How can I help? | ||
| When you send your pull request consider including information about | ||
| whether your change is breaking. If you think your patch can be backported | ||
| simply add to the commit message ```Consider this commit for LTS```. |
There was a problem hiding this comment.
Aren't the lts-watch tags for exactly this purpose?
There was a problem hiding this comment.
I was imagining that if new commits came in and that information was provided it could streamline the process and allow people to add the LTS review tag without having to dive into the code too much
|
How about some words on who's doing the backporting? |
|
@silverwind are you imagining that this would discuss the LTS working group? |
|
tweaked the copy a bit and added information about the release team. @silverwind please let me know if this is inline with what you were imagining |
| #### What is LTS? | ||
|
|
||
| Long Term Support (often referred to as LTS) is the process of | ||
| backporting non breaking changes to older versions of Node.js. LTS |
I don't think that's a good summary of LTS. Instead, it's a description of something that needs to happen as a result of LTS. If you don't want to explain what LTS is in full (and I think the way you subsequently link to a separate document for that is wise), you can make this sentence correct by changing it to:
If the LTS Plan doc is correct, then "non-breaking changes" will actually need to be changed to "bugfixes". LTS Plan says no new features. (Maybe that's been changed and the plan is to incorporate semver-minor changes?) |
|
|
||
| #### Who is doing the backporting? | ||
|
|
||
| Currently all backporting is being done by the release team. |
There was a problem hiding this comment.
(@nodejs/release) / link to https://github.com/orgs/nodejs/teams/release
|
@Trott I was considering "non breaking changes" to refer to the variety of supported fixes... but I can see how it can be seen as including features... tweaking copy now |
|
Copy has been updated. I accounted for all the nits. I then simplified the copy in "What is LTS" and added a section "How does LTS work?" that directly takes the copy from the LTS plan |
|
@Fishrock123 it just struck me that the link for @nodejs/release does not work if you are not a member of the org. |
| #### What is *LTS*? | ||
|
|
||
| Long Term Support (often referred to as LTS) guarantee application developers | ||
| a 30 month support cycle with specific versions of Node.js. |
|
Ok I just pushed an update that took into account all of @Trott's above suggestions. I decided to remove the paragraph listing what would be backported, as it is now included in the how does LTS work paragraph |
|
👍 |
|
|
||
| #### How does LTS work? | ||
|
|
||
| Once a release enters LTS, no new features may be added to that release. Changes are limited to |
There was a problem hiding this comment.
'Once a stable branch enters LTS, no new features may be added to that branch.' -- the release doesn't enter LTS, the stable branch transitions to LTS.
|
@jasnell updates made according to your notes As that copy was taken from nodejs/lts I'll make a PR to update the copy there (once this is merged) |
|
|
||
| #### Who is doing the backporting? | ||
|
|
||
| Currently all backporting is being done by [@nodejs/release](https://github.com/nodejs/node/blob/master/README.md#release-team). |
There was a problem hiding this comment.
The current plan is for commits to cherry pick into a staging branch first (e.g. v4.x-staging), which can be done by anyone -- in fact, the preference would be for the person landing the commit in master to also land the commit in the staging branch around the same time if the commit needs to land in the LTS. Then, when the LTS WG determines that a new LTS release is required, selected commits will be picked from the staging branch to the release branch (from from v4.x-staging to v4.x. It would be the responsibility of the person preparing the commit to pull the commits out of the v4.x-staging branch. The LTS WG works with the Release team on this process.
|
@jasnell I took another pass at the copy for who backports and added a section for how releases are made. Let me know what you think |
|
LGTM |
|
@nodejs/lts ... quick review before this lands? |
There is currently no information in the Collaborators guide regarding LTS. This commit adds some basic copy explaining what LTS is, what is considered for LTS, and a simple way collaborators can help.
|
@nodejs/lts bueler? |
|
+1 from me
|
There is currently no information in the Collaborators guide regarding LTS. This commit adds some basic copy explaining what LTS is, what is considered for LTS, and a simple way collaborators can help. Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Steven R. Loomis <srloomis@us.ibm.com> PR-URL: #3442
|
Landed in d394e9e |
There is currently no information in the Collaborators guide regarding LTS. This commit adds some basic copy explaining what LTS is, what is considered for LTS, and a simple way collaborators can help. Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Steven R. Loomis <srloomis@us.ibm.com> PR-URL: nodejs#3442
There is currently no information in the Collaborators guide regarding LTS. This commit adds some basic copy explaining what LTS is, what is considered for LTS, and a simple way collaborators can help. Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Steven R. Loomis <srloomis@us.ibm.com> PR-URL: #3442
|
landed in v4.x-staging in 9ce1f75 |
There is currently no information in the Collaborators guide regarding LTS. This commit adds some basic copy explaining what LTS is, what is considered for LTS, and a simple way collaborators can help. Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Steven R. Loomis <srloomis@us.ibm.com> PR-URL: #3442
There is currently no information in the Collaborators guide regarding LTS. This commit adds some basic copy explaining what LTS is, what is considered for LTS, and a simple way collaborators can help. Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Steven R. Loomis <srloomis@us.ibm.com> PR-URL: #3442
There is currently no information in the Collaborators guide regarding LTS. This commit adds some basic copy explaining what LTS is, what is considered for LTS, and a simple way collaborators can help. Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Steven R. Loomis <srloomis@us.ibm.com> PR-URL: #3442
There is currently no information in the Collaborators
guide regarding LTS. This commit adds some basic copy
explaining what LTS is, what is considered for LTS,
and a simple way collaborators can help.
Consider this commit for LTS.
Closes #3412