From b47ba103366b610dc66109e81721a44ceae30b99 Mon Sep 17 00:00:00 2001 From: Florian Dahlitz Date: Thu, 21 May 2020 19:08:45 +0200 Subject: [PATCH 1/4] Add a note about not modifying the git history to the quick guide --- pullrequest.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/pullrequest.rst b/pullrequest.rst index 859261948..7e85cb36b 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -37,7 +37,7 @@ Here is a quick overview of how you can contribute to CPython: #. `Create Pull Request`_ on GitHub to merge a branch from your fork -#. Review and address `comments on your Pull Request`_ +#. Review and address `comments on your Pull Request`_ (without force-pushing) #. When your changes are merged, you can :ref:`delete the PR branch ` @@ -47,6 +47,10 @@ Here is a quick overview of how you can contribute to CPython: .. [*] If an issue is trivial (e.g. typo fixes), or if an issue already exists, you can skip this step. +.. note:: + Please keep the commit history in the pull request intact by not squashing, + amending, or anything that would require a force push to GitHub. + .. _Clear communication: https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution .. _Open Source: https://opensource.guide/ .. _create an issue: https://bugs.python.org/ From 44820d7cd6db726ca4b525b05bc98ea9a1e2f09a Mon Sep 17 00:00:00 2001 From: Florian Dahlitz Date: Thu, 21 May 2020 20:17:33 +0200 Subject: [PATCH 2/4] Apply code review suggestions from @aeros --- pullrequest.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pullrequest.rst b/pullrequest.rst index 7e85cb36b..02b980e82 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -37,7 +37,7 @@ Here is a quick overview of how you can contribute to CPython: #. `Create Pull Request`_ on GitHub to merge a branch from your fork -#. Review and address `comments on your Pull Request`_ (without force-pushing) +#. Review and address `comments on your Pull Request`_ #. When your changes are merged, you can :ref:`delete the PR branch ` @@ -48,8 +48,8 @@ Here is a quick overview of how you can contribute to CPython: you can skip this step. .. note:: - Please keep the commit history in the pull request intact by not squashing, - amending, or anything that would require a force push to GitHub. + In order to keep the commit history intact, please avoid force-pushing to + the PR. .. _Clear communication: https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution .. _Open Source: https://opensource.guide/ From 3d539c64bd928de88e0012173cc16ca95c5f0f09 Mon Sep 17 00:00:00 2001 From: Florian Dahlitz Date: Fri, 22 May 2020 11:29:43 +0200 Subject: [PATCH 3/4] Apply changes as suggested by @terryjreedy --- pullrequest.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pullrequest.rst b/pullrequest.rst index 02b980e82..1c892616c 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -49,7 +49,7 @@ Here is a quick overview of how you can contribute to CPython: .. note:: In order to keep the commit history intact, please avoid force-pushing to - the PR. + the PR. Reviewers often want to look at individual commits. .. _Clear communication: https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution .. _Open Source: https://opensource.guide/ From 027b79bb6e4a81e211979a1572bcba9a3b08b448 Mon Sep 17 00:00:00 2001 From: Florian Dahlitz Date: Sat, 23 May 2020 07:55:52 +0200 Subject: [PATCH 4/4] Apply suggestions proposed by @willingc --- pullrequest.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/pullrequest.rst b/pullrequest.rst index 1c892616c..bd94cbe12 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -48,8 +48,9 @@ Here is a quick overview of how you can contribute to CPython: you can skip this step. .. note:: - In order to keep the commit history intact, please avoid force-pushing to - the PR. Reviewers often want to look at individual commits. + In order to keep the commit history intact, please avoid squashing or amending + history and then force-pushing to the PR. Reviewers often want to look at + individual commits. .. _Clear communication: https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution .. _Open Source: https://opensource.guide/