doc: update the Troubleshooting section of the Collaborator Guide by Trott · Pull Request #26652 · nodejs/node (original) (raw)
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 andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Conversation6 Commits2 Checks0 Files changed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
[ Show hidden characters]({{ revealButtonHref }})
Some changes to keep things simple and direct.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes- documentation is changed or added
- commit message follows commit guidelines
In the Troubleshooting portion of the Collaborator Guide, there is a copy/pasted error message. The message is out of date. More recent git contains a more concise and clear message. Update the text to reflect the current git error message.
In the Troubleshooting section of the Collaborator Guide, there is one particularly lengthy and difficult-to-understand sentence. Make it shorter and more clear.
(Change to the git hint: text is a copy/paste from a more recent git than what was used to generate the original message in the doc. I'm using git 2.14.2.)
| hint: to the same ref. You may want to first integrate the remote changes |
|---|
| hint: (e.g. 'git pull ...') before pushing again. |
| hint: Updates were rejected because the tip of your current branch is behind |
| hint: its remote counterpart. Integrate the remote changes (e.g. |
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The new description is definitely on the point and correct but the former one seems easier to understand or at least to me, it seems the former version required less knowledge about git. I personally would stick to the former version for the first sentence.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about just removing all the hint text and leaving lines 603-605? That's the relevant part anyway. The hint text will be whatever and we don't control it.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking at it again: I just realized this is 1-to-1 the actual git hint. Therefore it's probably indeed good to use that.
PRs that have at least one approval, no pending requests for changes, and a CI started.
label
Issues and PRs related to the general management of the project.
label
Landed in 5a23a87...22de2cf
Trott added a commit to Trott/io.js that referenced this pull request
In the Troubleshooting portion of the Collaborator Guide, there is a copy/pasted error message. The message is out of date. More recent git contains a more concise and clear message. Update the text to reflect the current git error message.
PR-URL: nodejs#26652 Reviewed-By: Ruben Bridgewater ruben@bridgewater.de Reviewed-By: Vse Mozhet Byt vsemozhetbyt@gmail.com
Trott added a commit to Trott/io.js that referenced this pull request
In the Troubleshooting section of the Collaborator Guide, there is one particularly lengthy and difficult-to-understand sentence. Make it shorter and more clear.
PR-URL: nodejs#26652 Reviewed-By: Ruben Bridgewater ruben@bridgewater.de Reviewed-By: Vse Mozhet Byt vsemozhetbyt@gmail.com
targos pushed a commit to targos/node that referenced this pull request
In the Troubleshooting portion of the Collaborator Guide, there is a copy/pasted error message. The message is out of date. More recent git contains a more concise and clear message. Update the text to reflect the current git error message.
PR-URL: nodejs#26652 Reviewed-By: Ruben Bridgewater ruben@bridgewater.de Reviewed-By: Vse Mozhet Byt vsemozhetbyt@gmail.com
targos pushed a commit to targos/node that referenced this pull request
In the Troubleshooting section of the Collaborator Guide, there is one particularly lengthy and difficult-to-understand sentence. Make it shorter and more clear.
PR-URL: nodejs#26652 Reviewed-By: Ruben Bridgewater ruben@bridgewater.de Reviewed-By: Vse Mozhet Byt vsemozhetbyt@gmail.com
targos pushed a commit that referenced this pull request
In the Troubleshooting portion of the Collaborator Guide, there is a copy/pasted error message. The message is out of date. More recent git contains a more concise and clear message. Update the text to reflect the current git error message.
PR-URL: #26652 Reviewed-By: Ruben Bridgewater ruben@bridgewater.de Reviewed-By: Vse Mozhet Byt vsemozhetbyt@gmail.com
targos pushed a commit that referenced this pull request
In the Troubleshooting section of the Collaborator Guide, there is one particularly lengthy and difficult-to-understand sentence. Make it shorter and more clear.
PR-URL: #26652 Reviewed-By: Ruben Bridgewater ruben@bridgewater.de Reviewed-By: Vse Mozhet Byt vsemozhetbyt@gmail.com
BethGriggs pushed a commit that referenced this pull request
In the Troubleshooting portion of the Collaborator Guide, there is a copy/pasted error message. The message is out of date. More recent git contains a more concise and clear message. Update the text to reflect the current git error message.
PR-URL: #26652 Reviewed-By: Ruben Bridgewater ruben@bridgewater.de Reviewed-By: Vse Mozhet Byt vsemozhetbyt@gmail.com
BethGriggs pushed a commit that referenced this pull request
In the Troubleshooting section of the Collaborator Guide, there is one particularly lengthy and difficult-to-understand sentence. Make it shorter and more clear.
PR-URL: #26652 Reviewed-By: Ruben Bridgewater ruben@bridgewater.de Reviewed-By: Vse Mozhet Byt vsemozhetbyt@gmail.com
This was referenced
May 29, 2019
This was referenced
Mar 11, 2021
This was referenced
May 25, 2021
This was referenced
Apr 7, 2022
This was referenced
Jan 31, 2023
Labels
PRs that have at least one approval, no pending requests for changes, and a CI started.
Issues and PRs related to the documentations.
Issues and PRs related to the general management of the project.