From 7a769ebba870fdfb18b6e04aab504d612133fc82 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 30 Apr 2018 06:43:15 -0700 Subject: [PATCH] doc: add squash guideline to pull-requests doc Tell the contributor to generally not squash commits during the pull request review process. PR-URL: https://github.com/nodejs/node/pull/20413 Reviewed-By: Colin Ihrig Reviewed-By: Trivikram Kamat Reviewed-By: James M Snell --- doc/guides/contributing/pull-requests.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index c248c1b9b6ec6f..a92e1cf305658b 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -599,9 +599,10 @@ whether the failure was caused by the changes in the Pull Request. ### Commit Squashing -When the commits in your Pull Request land, they may be squashed -into one commit per logical change. Metadata will be added to the commit -message (including links to the Pull Request, links to relevant issues, +In most cases, do not squash commits that you add to your Pull Request during +the review process. When the commits in your Pull Request land, they may be +squashed into one commit per logical change. Metadata will be added to the +commit message (including links to the Pull Request, links to relevant issues, and the names of the reviewers). The commit history of your Pull Request, however, will stay intact on the Pull Request page.