Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganize git commands #263

Merged
merged 7 commits into from Sep 7, 2017
Merged

Conversation

@ezio-melotti
Copy link
Member

@ezio-melotti ezio-melotti commented Sep 5, 2017

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:

  • Move the minimal configuration instructions
  • Move the remote configuration instructions
  • Move the pushing changes and synching remotes sections.
  • Review what is left of committing.rst

The end result will be:

  • setup.rst with basic setup instructions and links to the commands
  • pullrequest.rst with the bulk of commands that are common to both contributors and core devs in a reasonable order
  • committing.rst with info specific for core devs
  • gitbootcamp.rst with a FAQ-like, ctrl-f-able list of most of the git commands

See also #262.

@ezio-melotti ezio-melotti force-pushed the ezio-melotti:reorganize-git-commands branch from d8252ed to e764e1c Sep 6, 2017
@ezio-melotti ezio-melotti requested a review from willingc Sep 6, 2017

Reverts python/cpython#111.
Reason: This commit broke the buildbot.

This comment has been minimized.

@ezio-melotti

ezio-melotti Sep 6, 2017
Author Member

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.


This comment has been minimized.

@ezio-melotti

ezio-melotti Sep 6, 2017
Author Member

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

This comment has been minimized.

@ezio-melotti

ezio-melotti Sep 6, 2017
Author Member

This is already in the bootcamp (and somewhere else too).


Maintaining a repository

This comment has been minimized.

@ezio-melotti

ezio-melotti Sep 6, 2017
Author Member

After asking around during the sprint, the consensus was to remove this section.

@ezio-melotti ezio-melotti changed the title WIP: Reorganize git commands Reorganize git commands Sep 6, 2017
@ezio-melotti ezio-melotti requested a review from Mariatta Sep 6, 2017
Copy link
Collaborator

@willingc willingc left a comment

Looks great @ezio-melotti. There's a few small items and then it's ready to merge. Thanks 👍


origin git@github.com:<your-username>/devguide.git (fetch)
origin git@github.com:<your-username>/devguide.git (push)
upstream git@github.com:python/devguide.git (fetch)

This comment has been minimized.

@willingc

willingc Sep 6, 2017
Collaborator

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.

This comment has been minimized.

@ezio-melotti

ezio-melotti Sep 7, 2017
Author Member

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.

This comment has been minimized.

@Mariatta

Mariatta Sep 7, 2017
Member

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>`.

This comment has been minimized.

@willingc

willingc Sep 6, 2017
Collaborator

NIce! 👍

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>`.

This comment has been minimized.

@willingc

willingc Sep 6, 2017
Collaborator

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...

This comment has been minimized.

@ezio-melotti

ezio-melotti Sep 6, 2017
Author Member

"Personal" is probably the word I was looking for, but "your fork" is clear enough without additional qualifiers.

This comment has been minimized.

@willingc

willingc Sep 7, 2017
Collaborator

I like personal 👍

This comment has been minimized.

@ezio-melotti

ezio-melotti Sep 7, 2017
Author Member

I fixed this in #265

Copy link
Collaborator

@willingc willingc left a comment

Thanks @ezio-melotti.

@ezio-melotti ezio-melotti force-pushed the ezio-melotti:reorganize-git-commands branch from 2905cf3 to a3c6133 Sep 7, 2017
@ezio-melotti ezio-melotti merged commit 90747c5 into python:master Sep 7, 2017
1 check passed
1 check passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@ezio-melotti ezio-melotti deleted the ezio-melotti:reorganize-git-commands branch Sep 7, 2017
@ezio-melotti
Copy link
Member Author

@ezio-melotti ezio-melotti commented Sep 7, 2017

Thanks for the reviews!

@willingc
Copy link
Collaborator

@willingc willingc commented Sep 7, 2017

Way to go @ezio-melotti on reorganizing 🍰

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
You can’t perform that action at this time.