Skip to content

Reorganize git commands - #263

Merged
ezio-melotti merged 7 commits into
python:masterfrom
ezio-melotti:reorganize-git-commands
Sep 7, 2017
Merged

Reorganize git commands#263
ezio-melotti merged 7 commits into
python:masterfrom
ezio-melotti:reorganize-git-commands

Conversation

@ezio-melotti

@ezio-melottiezio-melotti commented Sep 5, 2017

Copy link
Copy Markdown
Member

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.

Comment threadcommitting.rst

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has been moved after the section about backporting.

Comment threadcommitting.rst
The above steps can be executed against any branch you wish to, just replace master
with an appropriate branch name.


Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the stuff in this chunk either got added to the bootcamp or it was already there

Comment threadcommitting.rst

.. _forking:

Forking repository

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment threadcommitting.rst
Reverting a Merged Pull Request
-------------------------------

Maintaining a repository

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@ezio-melottiezio-melotti changed the title WIP: Reorganize git commandsReorganize git commandsSep 6, 2017

@willingcwillingc left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment threadgitbootcamp.rst

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)

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment threadsetup.rst
``git push``, or ``git fetch``.

``git push``, or ``git fetch``. On Windows, you should also
:ref:`enable autocrlf <autocrlf>`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NIce! 👍

Comment threadsetup.rst
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>`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like personal 👍

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fixed this in #265

@willingcwillingc left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ezio-melotti
ezio-melotti merged commit 90747c5 into python:masterSep 7, 2017
@ezio-melotti
ezio-melotti deleted the reorganize-git-commands branch September 7, 2017 20:39
@ezio-melotti

Copy link
Copy Markdown
MemberAuthor

Thanks for the reviews!

@willingc

Copy link
Copy Markdown
Collaborator

Way to go @ezio-melotti on reorganizing 🍰

AA-Turner pushed a commit to AA-Turner/devguide that referenced this pull request Jun 17, 2022
* 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.
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@ezio-melotti@willingc@Mariatta@the-knights-who-say-ni