doc: remove squash guideline from onboarding doc #20413
Closed
Conversation
This file contains 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
|
Some recent examples of Collaborators squashing or asking others to squash before the end of work. Again, I don't have a problem with this practice. I've certainly done it myself many times. I just don't think we should have our docs say one thing and then ask people to do something different. Easiest thing to do is to remove the one sentence from our docs which is what this PR does.
|
|
LinuxONE re-run: https://ci.nodejs.org/job/node-test-pull-request-lite/630/ |
vsemozhetbyt
changed the title
vsemozhetbyt
added
the
meta
Although I agree with the guideline people should generally not squash commits in a pull request until the end (in other words, until it's time to land the PR), it is clear from comments and actions in the issue tracker that many do not share that view. This is fine by me, but I do think that we should our documentation should reflect our practices rather than being an aspirational statement. If we *do* wish to preserve this recommendation, it probably belongs in another document anyway as this is not a recommendation for Collaborators only but for anyone opening a pull request.
cjihrig
approved these changes
Apr 30, 2018
|
I am -1 on removing this. I personally think we should really stick to it. Removing the comment does not help. Instead, we could go ahead and elaborate when exactly it might make sense to ask for squashing (because there are exceptions to the rule) and how it should be done in the end. Such exceptions could for example be:
|
OK, I'll change this to move it to https://github.com/nodejs/node/blob/283a967e356311a467113eea450a81827d43c969/doc/guides/contributing/pull-requests.md#commit-squashing. |
Tell the contributor to generally not squash commits during the pull request review process.
|
@BridgeAR PTAL |
|
I am fine with the addition but I would rather keep it in onboarding as well. |
trivikr
approved these changes
Apr 30, 2018
@BridgeAR How about if instead of the onboarding docs, and along with the addition to |
jasnell
approved these changes
May 2, 2018
Trott
added a commit
to Trott/io.js
that referenced
this pull request
May 3, 2018
Although I agree with the guideline people should generally not squash commits in a pull request until the end (in other words, until it's time to land the PR), it is clear from comments and actions in the issue tracker that many do not share that view. This is fine by me, but I do think that we should our documentation should reflect our practices rather than being an aspirational statement. If we *do* wish to preserve this recommendation, it probably belongs in another document anyway as this is not a recommendation for Collaborators only but for anyone opening a pull request. PR-URL: nodejs#20413 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Trott
added a commit
to Trott/io.js
that referenced
this pull request
May 3, 2018
Tell the contributor to generally not squash commits during the pull request review process. PR-URL: nodejs#20413 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
|
Landed in 7588cea...24a5ac7 If we want to add the information to COLLABORATOR_GUIDE.md or onboarding.md, that can be done in a subsequent PR. |
MylesBorins
pushed a commit
that referenced
this pull request
May 4, 2018
Although I agree with the guideline people should generally not squash commits in a pull request until the end (in other words, until it's time to land the PR), it is clear from comments and actions in the issue tracker that many do not share that view. This is fine by me, but I do think that we should our documentation should reflect our practices rather than being an aspirational statement. If we *do* wish to preserve this recommendation, it probably belongs in another document anyway as this is not a recommendation for Collaborators only but for anyone opening a pull request. PR-URL: #20413 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
May 4, 2018
Tell the contributor to generally not squash commits during the pull request review process. PR-URL: #20413 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
MylesBorins
pushed a commit
that referenced
this pull request
May 8, 2018
Although I agree with the guideline people should generally not squash commits in a pull request until the end (in other words, until it's time to land the PR), it is clear from comments and actions in the issue tracker that many do not share that view. This is fine by me, but I do think that we should our documentation should reflect our practices rather than being an aspirational statement. If we *do* wish to preserve this recommendation, it probably belongs in another document anyway as this is not a recommendation for Collaborators only but for anyone opening a pull request. PR-URL: #20413 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
May 8, 2018
Tell the contributor to generally not squash commits during the pull request review process. PR-URL: #20413 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Although I agree with the guideline people should generally not squash
commits in a pull request until the end (in other words, until it's time
to land the PR), it is clear from comments and actions in the issue
tracker that many do not share that view. This is fine by me, but I do
think that we should our documentation should reflect our practices
rather than being an aspirational statement.
If we do wish to preserve this recommendation, it probably belongs in
another document anyway as this is not a recommendation for
Collaborators only but for anyone opening a pull request.
Checklist