Add missing git command to pull request guide #510
Conversation
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.
There was a problem hiding this comment.
@zthompson47 Welcome and thanks for the contribution! LGTM.
As a minor addition, it would be helpful to briefly mention that an upstream must be configured as a remote in order for this to work. The devguide already has a section explaining how to do this, but the pullrequest page likely attracts many new contributors that might not be familiar with using git.
This wouldn't be worthwhile to mention multiple times within the section, but mentioning it once wouldn't hurt.
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 <aeros167@gmail.com>
There was a problem hiding this comment.
Thanks for the PR @zthompson47 and @aeros167 for the review. I think it would be helpful to break out updating the upstream remote into its own bullet.
|
@willingc Just a quick note that my reply ended up in the prior resolved conversation but you probably saw it. Thanks! |
|
Thanks @zthompson47 😄 |
* 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 python#509. * 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 <aeros167@gmail.com> * Move extra git step to its own bullet point
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.