From 2a5ed02c52e09da7a124cae3a9963560c6bd2226 Mon Sep 17 00:00:00 2001 From: Zach Thompson Date: Tue, 16 Jul 2019 18:19:55 -0400 Subject: [PATCH 1/3] Add missing git command to pull request guide The pull request step-by-step guide provides instructions to create a git branch using upstream/master as the start-point. This commit adds a command to the guide which safely makes sure that this start-point exists in the local repository. Fixes #509. --- pullrequest.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/pullrequest.rst b/pullrequest.rst index 1a7385425..80b4b06d3 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -66,6 +66,7 @@ You should have already :ref:`set up your system `, * Create a new branch in your local clone:: + git fetch upstream git checkout -b upstream/master * Make changes to the code, and use ``git status`` and ``git diff`` to see them. From 3ca920449fdc0f838f410238a59dca73c9752d2b Mon Sep 17 00:00:00 2001 From: Zach Thompson Date: Thu, 18 Jul 2019 08:04:29 -0400 Subject: [PATCH 2/3] Clarify the need to configure git remote This added comment explains the need for an existing remote to create a branch from. The prerequisite git workflow is already documented. Co-Authored-By: Kyle Stanley --- pullrequest.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pullrequest.rst b/pullrequest.rst index 80b4b06d3..282b0f053 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -66,7 +66,7 @@ You should have already :ref:`set up your system `, * Create a new branch in your local clone:: - git fetch upstream + git fetch upstream # upstream must be configured as a remote git checkout -b upstream/master * Make changes to the code, and use ``git status`` and ``git diff`` to see them. From 964f616fce8aaa2c9dc3e6c4c5109f568ea73dd3 Mon Sep 17 00:00:00 2001 From: Zach Thompson Date: Mon, 22 Jul 2019 08:09:18 -0400 Subject: [PATCH 3/3] Move extra git step to its own bullet point --- pullrequest.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/pullrequest.rst b/pullrequest.rst index 282b0f053..cdeab54b3 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -64,9 +64,12 @@ Step-by-step Guide You should have already :ref:`set up your system `, :ref:`got the source code `, and :ref:`built Python `. +* Update data from your ``upstream`` repository:: + + git fetch upstream + * Create a new branch in your local clone:: - git fetch upstream # upstream must be configured as a remote git checkout -b upstream/master * Make changes to the code, and use ``git status`` and ``git diff`` to see them.