From 63b3be2f1310c44d045c58dce612d08c525e2ad2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miloslav=20Trma=C4=8D?= Date: Mon, 6 Nov 2017 16:21:50 +0100 Subject: [PATCH] Modify CONTRIBUTING.md to prefer smaller commits over squashing them MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit See the updated text for the rationale. Signed-off-by: Miloslav Trmač --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a9b8cb7a..be347633 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,9 +49,9 @@ Regardless of the type of PR, all PRs should include: * documentation changes Squash your commits into logical pieces of work that might want to be reviewed -separate from the rest of the PRs. But, squashing down to just one commit is ok -too since in the end the entire PR will be reviewed anyway. When in doubt, -squash. +separate from the rest of the PRs. Ideally, each commit should implement a single +idea, and the PR branch should pass the tests at every commit. GitHub makes it easy +to review the cumulative effect of many commits; so, when in doubt, use smaller commits. PRs that fix issues should include a reference like `Closes #XXXX` in the commit message so that github will automatically close the referenced issue