Thanks to visit codestin.com
Credit goes to github.com

Skip to content

adding pullrequest guide for #103 #140

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

Merged
merged 19 commits into from
Apr 12, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions committing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,8 @@ After that, your remotes configuration should look like this::
At any point in time you can use SSH-based URL instead of HTTPS-based ones.


.. _committing-push-changes:

Pushing changes
'''''''''''''''

Expand Down Expand Up @@ -375,6 +377,8 @@ The above steps can be executed against any branch you wish to, just replace mas
with an appropriate branch name.


.. _committing-active-branches:

Active branches
---------------

Expand Down
79 changes: 79 additions & 0 deletions pullrequest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,85 @@ command (after any successful build of Python)::
python.bat Tools/scripts/patchcheck.py


.. _pullrequest-quickguide:

Quick Guide
'''''''''''

`Clear communication`_ is key to contributing to any project, especially an
`Open Source`_ project like Python.

Here is a quick overview of how you can contribute to CPython on GitHub:

1. If an Issue doesn't exist, `create an Issue`_ that describes your change

2. :ref:`Get started <setup>` and set up your system

3. Fork `CPython`_ on GitHub (using the Fork button in the upper-right on GitHub)

4. :ref:`Build Python <compiling>` on your system

5. :ref:`Run tests <runtests>` after you have built Python

6. :ref:`Add an "upstream" Remote in Git <remote-configuration>` (using SSH, or you can `use HTTPS`_)

7. :ref:`Create a Branch in Git <pullrequest-steps>` where you can work on changes

8. :ref:`Run tests <runtests>` again

9. :ref:`Push commits <committing-push-changes>` to your Github repo

10. `Create Pull Request`_ in Github to merge a branch from your Fork

11. Review and address `comments on your Pull Request`_

12. When your changes are merged, celebrate contributing to Python! :)

.. _Clear communication: https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution
.. _Open Source: https://opensource.guide/
.. _create an Issue: https://bugs.python.org/
.. _CPython: https://github.com/python/cpython
.. _use HTTPS: https://help.github.com/articles/which-remote-url-should-i-use/
.. _Create Pull Request: https://help.github.com/articles/creating-a-pull-request/
.. _comments on your Pull Request: https://help.github.com/articles/commenting-on-a-pull-request/


.. _pullrequest-steps:

Quick Guide Step-by-step
''''''''''''''''''''''''

Set up your system (using SSH, or you can `use HTTPS`_)::

git clone [email protected]:YOUR_GITHUB_ID/cpython.git

Replace **YOUR_GITHUB_ID** with your GitHub account name above, then add upstream (using SSH, or you can `use HTTPS`_)::

git remote add upstream git://github.com/python/cpython.git

Work on new features or fixes::

git checkout -b MY_BRANCH_NAME upstream/master

As you work, commit changes::

git commit

Then fetch upstream to see if anything conflicts with your changes::

git fetch upstream

Then push your work to your clone on GitHub::

git push origin MY_BRANCH_NAME

Make a Pull Request on GitHub from your changes in **MY_BRANCH_NAME**.

.. note::
You can upload a patch to https://bugs.python.org/, but Pull Requests
on GitHub are preferred.


Licensing
---------

Expand Down