From 4863d051362bd3b766f5876a533dba55797a30c6 Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Sun, 16 Feb 2020 19:45:56 +0100 Subject: [PATCH] Recommend to amend pull requests --- doc/devel/coding_guide.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst index e0d1132e020c..c5140ac6bc82 100644 --- a/doc/devel/coding_guide.rst +++ b/doc/devel/coding_guide.rst @@ -32,6 +32,12 @@ When making a PR, pay attention to: feedback from the developers. You may mark these as `draft pull requests `_ on GitHub. +* When updating your PR, instead of adding new commits to fix something, please + consider amending your initial commit(s) to keep the history clean. + You can achieve this using:: + + git commit --amend --no-edit + git push [your-remote-repo] [your-branch] --force-with-lease See also :ref:`contributing` for how to make a PR.