diff options
| author | Rich Trott <rtrott@gmail.com> | 2018-04-30 06:43:15 -0700 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2018-05-02 19:16:25 -0700 |
| commit | 24a5ac797d6eb2431d532ddb3a9e2062490a7737 (patch) | |
| tree | 277ecae61ad778727b19b6d1c80c8d6584eee665 /doc/guides/contributing | |
| parent | ac6d1f20b9668d5f904d9e592bfd0ae0bfd3445e (diff) | |
| download | android-node-v8-24a5ac797d6eb2431d532ddb3a9e2062490a7737.tar.gz android-node-v8-24a5ac797d6eb2431d532ddb3a9e2062490a7737.tar.bz2 android-node-v8-24a5ac797d6eb2431d532ddb3a9e2062490a7737.zip | |
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 <cjihrig@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/guides/contributing')
| -rw-r--r-- | doc/guides/contributing/pull-requests.md | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index c248c1b9b6..a92e1cf305 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. |