Reorganize git commands #263
Conversation
|
|
||
| Reverts python/cpython#111. | ||
| Reason: This commit broke the buildbot. | ||
|
|
There was a problem hiding this comment.
This has been moved after the section about backporting.
| The above steps can be executed against any branch you wish to, just replace master | ||
| with an appropriate branch name. | ||
|
|
||
|
|
There was a problem hiding this comment.
All the stuff in this chunk either got added to the bootcamp or it was already there
| @@ -454,34 +336,19 @@ Developers can apply labels to GitHub pull requests). | |||
| .. _cherry_picker.py: https://github.com/python/core-workflow/tree/master/cherry_picker | |||
|
|
|||
|
|
|||
| .. _forking: | |||
|
|
|||
| Forking repository | |||
There was a problem hiding this comment.
This is already in the bootcamp (and somewhere else too).
|
|
||
| Maintaining a repository |
There was a problem hiding this comment.
After asking around during the sprint, the consensus was to remove this section.
There was a problem hiding this comment.
Looks great @ezio-melotti. There's a few small items and then it's ready to merge. Thanks 👍
|
|
||
| origin [email protected]:<your-username>/devguide.git (fetch) | ||
| origin [email protected]:<your-username>/devguide.git (push) | ||
| upstream [email protected]:python/devguide.git (fetch) |
There was a problem hiding this comment.
Since this doc will often be used by contributors that do not have push privileges for CPython, the upstream remote should point to https://github.com/python/cpython in the doc here.
Perhaps a note for committers that they should use what you have here for upstream.
There was a problem hiding this comment.
AFAICT, with this URL, they still should be able to fetch. If they try to push they will get an error because they don't have privileges, but that's OK since they are not supposed to push on upstream anyway. Unless I'm missing something, this URL should be fine for both contributors and core devs.
There was a problem hiding this comment.
Thanks @willingc and @ezio-melotti. I'm thinking it's fine to leave the upstream using SSH url.
For contributors, they would have to configure SSH key anyway.
| ``git push``, or ``git fetch``. | ||
|
|
||
| ``git push``, or ``git fetch``. On Windows, you should also | ||
| :ref:`enable autocrlf <autocrlf>`. |
| git clone https://github.com/python/cpython | ||
| In order to get a copy of the source code you should first :ref:`fork the | ||
| Python repository on GitHub <fork-cpython>` and then :ref:`create a local | ||
| clone of your private fork and configure the remotes <clone-your-fork>`. |
There was a problem hiding this comment.
private I know what you are trying to say here but the fork is public. I think it is better to use ...clone of your fork and configure...
There was a problem hiding this comment.
"Personal" is probably the word I was looking for, but "your fork" is clear enough without additional qualifiers.
There was a problem hiding this comment.
I fixed this in #265
|
Thanks for the reviews! |
|
Way to go @ezio-melotti on reorganizing 🍰 |
* Move the minimal configuration instructions. * Move the remote configuration instructions. * Move the pushing changes and synching remotes sections. * First cleanup pass. * Remove the "Maintaining a repository" section. * Move the "Reverting a Merged Pull Request" section under "Working with Git". * Fix incorrect markup.
This is part of #120. The goal of this PR is to reorganize the git commands, that are currently scattered around a few pages.
The steps are:
The end result will be:
See also #262.