From 6e1d0930bf55aafa835f6ccbbc3691e2c67c9d2d Mon Sep 17 00:00:00 2001 From: Carl Lerche Date: Mon, 18 Dec 2017 22:22:40 -0800 Subject: [PATCH] Tweak CONTRIBUTING --- CONTRIBUTING.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 294a5a8..fa0b263 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,10 +21,14 @@ Do you have an improvement? ## Committing ## -We prefer squash or rebase commits so that all changes from a branch are -committed to master as a single commit. All pull requests are squashed when -merged, but rebasing prior to merge gives you better control over the commit -message. +When initially submitting a pull request, we prefer a single squashed commit. It +is preferable to split up contributions into multiple pull requests if the +changes are unrelated. All pull requests are squashed when merged, but +squashing yourself gives you better control over the commit message. + +After the pull request is submitted, all changes should be done in separate +commits. This makes reviewing the evolution of the pull request easier. We will +squash all the changes into a single commit when we merge the pull request. ### Commit messages ### @@ -78,4 +82,3 @@ changes should include before- and after- benchmark results. [issue]: https://github.com/carllerche/h2/issues/new [gitter]: https://gitter.im/tokio-rs/tokio -[rustfmt]: https://github.com/rust-lang-nursery/rustfmt