From 9e3cc06fb361a7e462cc7383e9e3b0abd41c9877 Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Sun, 5 Mar 2017 12:13:01 -0800 Subject: [PATCH 01/19] adding pullrequest guide for #103 --- pullrequest.rst | 83 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) diff --git a/pullrequest.rst b/pullrequest.rst index 7e479f532..c6b2100e6 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -93,6 +93,89 @@ command (after any successful build of Python):: python.bat Tools/scripts/patchcheck.py +Quick Guide +''''''''''' + +`Clear communication`_ is key to contributing to any project, especially an +`Open Source`_ project like Python. + +Here is a quick overview of you can contribute to CPython on Github: + +1. `Create an Issue`_ that describes your change, if it doesn't exist and you're explicitly working on something + +2. `Get started`_ and set up your system + +3. Fork `CPython on Github`_ (using the Fork button in the upper-right on Github) + +4. `Compile Python`_ on your system + +5. `Run tests`_ after you have built Python + +6. `Add an "upstream" Remote in Git`_ on your system + +7. `Create a Branch in Git`_ where you can work on changes + +8. Commit changes and `resolve conflicts in Git`_ + +9. `Run tests`_ again + +10. `Push commits`_ to your Github repo + +11. `Create Pull Request`_ in Github to merge a branch from your Fork + +12. Celebrate! You just contributed 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/ +.. _Get started: https://cpython-devguide.readthedocs.io/setup.html#getting-started +.. _CPython on Github: https://github.com/python/cpython +.. _Compile Python: https://cpython-devguide.readthedocs.io/setup.html#compiling-for-debugging +.. _Run tests: https://cpython-devguide.readthedocs.io/runtests.html#running-writing-tests +.. _Add an "upstream" Remote in Git: https://cpython-devguide.readthedocs.io/committing.html#remotes-setup +.. _Create a Branch in Git: https://cpython-devguide.readthedocs.io/committing.html#active-branches +.. _resolve conflicts in Git: https://cpython-devguide.readthedocs.io/committing.html#squashing-commits +.. _Run tests: https://cpython-devguide.readthedocs.io/runtests.html#running-writing-tests +.. _Push commits: https://cpython-devguide.readthedocs.io/committing.html#pushing-changes +.. _Create Pull Request: https://help.github.com/articles/creating-a-pull-request/ + + +Quick Guide Step-by-step +'''''''''''''''''''''''' + +Set up your system:: + + git clone git@github.com:YOUR_GITHUB_ID/cpython.git + +Replace **YOUR_GITHUB_ID** with your Github account name above, then add upstream:: + + git remote add upstream git://github.com/python/cpython.git + +Work on new features or fixes:: + + git checkout -b MY_NEW_FEATURE upstream/master + +As you work, please create a separate commit for each bug fix or feature change:: + + git commit + +Then fetch upstream to see if anything conflicts with your changes:: + + git fetch upstream + +Use rebase -i to verify what you commit and squish small commits:: + + git rebase -i upstream/master + +Then push your work to your clone on Github:: + + git push origin MY_NEW_FEATURE + +When you're ready, make a Pull Request on Github and refer to your branch named **MY_NEW_FEATURE**. + +*Though submitting a Pull Request on Github is the preferred method of contribution, you can alternatively upload a patch to bugs.python.org* + + Licensing --------- From b62d78d34e824a0a9b4ae2a01deec6200c4e802a Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Sat, 11 Mar 2017 10:48:11 -0800 Subject: [PATCH 02/19] replaces GitHub, word caps --- pullrequest.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/pullrequest.rst b/pullrequest.rst index c6b2100e6..677f2cf8b 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -99,13 +99,13 @@ Quick Guide `Clear communication`_ is key to contributing to any project, especially an `Open Source`_ project like Python. -Here is a quick overview of you can contribute to CPython on Github: +Here is a quick overview of you can contribute to CPython on GitHub: 1. `Create an Issue`_ that describes your change, if it doesn't exist and you're explicitly working on something 2. `Get started`_ and set up your system -3. Fork `CPython on Github`_ (using the Fork button in the upper-right on Github) +3. Fork `CPython on GitHub`_ (using the Fork button in the upper-right on GitHub) 4. `Compile Python`_ on your system @@ -119,9 +119,9 @@ Here is a quick overview of you can contribute to CPython on Github: 9. `Run tests`_ again -10. `Push commits`_ to your Github repo +10. `Push commits`_ to your GitHub repo -11. `Create Pull Request`_ in Github to merge a branch from your Fork +11. `Create Pull Request`_ in GitHub to merge a branch from your Fork 12. Celebrate! You just contributed to Python. :) @@ -129,7 +129,7 @@ Here is a quick overview of you can contribute to CPython on Github: .. _Open Source: https://opensource.guide/ .. _Create an Issue: https://bugs.python.org/ .. _Get started: https://cpython-devguide.readthedocs.io/setup.html#getting-started -.. _CPython on Github: https://github.com/python/cpython +.. _CPython on GitHub: https://github.com/python/cpython .. _Compile Python: https://cpython-devguide.readthedocs.io/setup.html#compiling-for-debugging .. _Run tests: https://cpython-devguide.readthedocs.io/runtests.html#running-writing-tests .. _Add an "upstream" Remote in Git: https://cpython-devguide.readthedocs.io/committing.html#remotes-setup @@ -147,7 +147,7 @@ Set up your system:: git clone git@github.com:YOUR_GITHUB_ID/cpython.git -Replace **YOUR_GITHUB_ID** with your Github account name above, then add upstream:: +Replace **YOUR_GITHUB_ID** with your GitHub account name above, then add upstream:: git remote add upstream git://github.com/python/cpython.git @@ -167,13 +167,13 @@ Use rebase -i to verify what you commit and squish small commits:: git rebase -i upstream/master -Then push your work to your clone on Github:: +Then push your work to your clone on GitHub:: git push origin MY_NEW_FEATURE -When you're ready, make a Pull Request on Github and refer to your branch named **MY_NEW_FEATURE**. +When you're ready, make a Pull Request on GitHub and refer to your branch named **MY_NEW_FEATURE**. -*Though submitting a Pull Request on Github is the preferred method of contribution, you can alternatively upload a patch to bugs.python.org* +*Though submitting a Pull Request on GitHub is the preferred method of contribution, you can alternatively upload a patch to bugs.python.org* Licensing From 21b4960ba945e9fce0b2c79f388d541e508442e5 Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Sat, 11 Mar 2017 10:52:08 -0800 Subject: [PATCH 03/19] edits - create issue --- pullrequest.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pullrequest.rst b/pullrequest.rst index 677f2cf8b..3f792c607 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -101,7 +101,7 @@ Quick Guide Here is a quick overview of you can contribute to CPython on GitHub: -1. `Create an Issue`_ that describes your change, if it doesn't exist and you're explicitly working on something +1. If an issue doesn't already exist, `create an Issue`_ that describes your change 2. `Get started`_ and set up your system @@ -127,7 +127,7 @@ Here is a quick overview of you can contribute to CPython on GitHub: .. _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/ +.. _create an Issue: https://bugs.python.org/ .. _Get started: https://cpython-devguide.readthedocs.io/setup.html#getting-started .. _CPython on GitHub: https://github.com/python/cpython .. _Compile Python: https://cpython-devguide.readthedocs.io/setup.html#compiling-for-debugging From 0b68c42198f59cd5fb9523fba551ad69ac31ec7d Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Sat, 11 Mar 2017 10:52:27 -0800 Subject: [PATCH 04/19] edits - upstream remote --- pullrequest.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pullrequest.rst b/pullrequest.rst index 3f792c607..e3d67e252 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -111,7 +111,7 @@ Here is a quick overview of you can contribute to CPython on GitHub: 5. `Run tests`_ after you have built Python -6. `Add an "upstream" Remote in Git`_ on your system +6. `Add an "upstream" Git remote`_ on your system 7. `Create a Branch in Git`_ where you can work on changes @@ -132,7 +132,7 @@ Here is a quick overview of you can contribute to CPython on GitHub: .. _CPython on GitHub: https://github.com/python/cpython .. _Compile Python: https://cpython-devguide.readthedocs.io/setup.html#compiling-for-debugging .. _Run tests: https://cpython-devguide.readthedocs.io/runtests.html#running-writing-tests -.. _Add an "upstream" Remote in Git: https://cpython-devguide.readthedocs.io/committing.html#remotes-setup +.. _Add an "upstream" Git remote: https://cpython-devguide.readthedocs.io/committing.html#remotes-setup .. _Create a Branch in Git: https://cpython-devguide.readthedocs.io/committing.html#active-branches .. _resolve conflicts in Git: https://cpython-devguide.readthedocs.io/committing.html#squashing-commits .. _Run tests: https://cpython-devguide.readthedocs.io/runtests.html#running-writing-tests From 523b77f77e8d73481193bb4402abdba128d9ae79 Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Sat, 11 Mar 2017 10:53:30 -0800 Subject: [PATCH 05/19] clearer create issue --- pullrequest.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pullrequest.rst b/pullrequest.rst index e3d67e252..d79cece49 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -101,7 +101,7 @@ Quick Guide Here is a quick overview of you can contribute to CPython on GitHub: -1. If an issue doesn't already exist, `create an Issue`_ that describes your change +1. If an Issue doesn't exist, `create an Issue`_ that describes your change 2. `Get started`_ and set up your system From e0aac2a0196d31de7495132963d42a439174c8a7 Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Sat, 11 Mar 2017 10:56:11 -0800 Subject: [PATCH 06/19] edits - cpython pull req --- pullrequest.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pullrequest.rst b/pullrequest.rst index d79cece49..6582e9c74 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -105,7 +105,7 @@ Here is a quick overview of you can contribute to CPython on GitHub: 2. `Get started`_ and set up your system -3. Fork `CPython on GitHub`_ (using the Fork button in the upper-right on GitHub) +3. Fork `CPython`_ on GitHub (using the Fork button in the upper-right on GitHub) 4. `Compile Python`_ on your system @@ -121,7 +121,7 @@ Here is a quick overview of you can contribute to CPython on GitHub: 10. `Push commits`_ to your GitHub repo -11. `Create Pull Request`_ in GitHub to merge a branch from your Fork +11. `Create Pull Request`_ in GitHub to request your changes to be merged into `CPython`_ 12. Celebrate! You just contributed to Python. :) @@ -129,7 +129,7 @@ Here is a quick overview of you can contribute to CPython on GitHub: .. _Open Source: https://opensource.guide/ .. _create an Issue: https://bugs.python.org/ .. _Get started: https://cpython-devguide.readthedocs.io/setup.html#getting-started -.. _CPython on GitHub: https://github.com/python/cpython +.. _CPython: https://github.com/python/cpython .. _Compile Python: https://cpython-devguide.readthedocs.io/setup.html#compiling-for-debugging .. _Run tests: https://cpython-devguide.readthedocs.io/runtests.html#running-writing-tests .. _Add an "upstream" Git remote: https://cpython-devguide.readthedocs.io/committing.html#remotes-setup From 24149d3c7ad766418ea31829f485f407e8431acb Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Sat, 11 Mar 2017 11:04:16 -0800 Subject: [PATCH 07/19] edit - pull req --- pullrequest.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pullrequest.rst b/pullrequest.rst index 6582e9c74..2cbf387e5 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -121,7 +121,7 @@ Here is a quick overview of you can contribute to CPython on GitHub: 10. `Push commits`_ to your GitHub repo -11. `Create Pull Request`_ in GitHub to request your changes to be merged into `CPython`_ +11. `Create Pull Request`_ for your changes to be reviewed then merged into `CPython`_ 12. Celebrate! You just contributed to Python. :) From 044dc08d82e7e5fc14d850ace5b31dfb5de8873f Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Sat, 11 Mar 2017 11:13:00 -0800 Subject: [PATCH 08/19] edit - run tests, then commit --- pullrequest.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/pullrequest.rst b/pullrequest.rst index 2cbf387e5..da485bfd2 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -115,9 +115,9 @@ Here is a quick overview of you can contribute to CPython on GitHub: 7. `Create a Branch in Git`_ where you can work on changes -8. Commit changes and `resolve conflicts in Git`_ +8. `Run tests`_ again -9. `Run tests`_ again +9. Commit changes and `resolve conflicts in Git`_ 10. `Push commits`_ to your GitHub repo From ca8e9c1f0793a414269943b96b039a793b8b097f Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Sat, 11 Mar 2017 11:14:02 -0800 Subject: [PATCH 09/19] https or ssh --- pullrequest.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pullrequest.rst b/pullrequest.rst index da485bfd2..00a52abbd 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -111,7 +111,7 @@ Here is a quick overview of you can contribute to CPython on GitHub: 5. `Run tests`_ after you have built Python -6. `Add an "upstream" Git remote`_ on your system +6. `Add an "upstream" Git remote`_ on your system (for SSH, or you can `use HTTPS`_) 7. `Create a Branch in Git`_ where you can work on changes @@ -133,6 +133,7 @@ Here is a quick overview of you can contribute to CPython on GitHub: .. _Compile Python: https://cpython-devguide.readthedocs.io/setup.html#compiling-for-debugging .. _Run tests: https://cpython-devguide.readthedocs.io/runtests.html#running-writing-tests .. _Add an "upstream" Git remote: https://cpython-devguide.readthedocs.io/committing.html#remotes-setup +.. _use HTTPS: https://help.github.com/articles/which-remote-url-should-i-use/ .. _Create a Branch in Git: https://cpython-devguide.readthedocs.io/committing.html#active-branches .. _resolve conflicts in Git: https://cpython-devguide.readthedocs.io/committing.html#squashing-commits .. _Run tests: https://cpython-devguide.readthedocs.io/runtests.html#running-writing-tests From a3ddf1c655c05eee99d53833550c6f793388e00f Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Sat, 11 Mar 2017 11:20:56 -0800 Subject: [PATCH 10/19] clarifying when to celebrate a pr --- pullrequest.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/pullrequest.rst b/pullrequest.rst index 00a52abbd..18a62e438 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -123,7 +123,9 @@ Here is a quick overview of you can contribute to CPython on GitHub: 11. `Create Pull Request`_ for your changes to be reviewed then merged into `CPython`_ -12. Celebrate! You just contributed to Python. :) +12. Review and address `comments on your Pull Request`_ + +13. 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/ @@ -139,6 +141,7 @@ Here is a quick overview of you can contribute to CPython on GitHub: .. _Run tests: https://cpython-devguide.readthedocs.io/runtests.html#running-writing-tests .. _Push commits: https://cpython-devguide.readthedocs.io/committing.html#pushing-changes .. _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/ Quick Guide Step-by-step From a6b773c5106e506e025c8d405e623edf2d1d03db Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Sat, 11 Mar 2017 11:49:08 -0800 Subject: [PATCH 11/19] adding refs --- committing.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/committing.rst b/committing.rst index dce5f74a6..1144973c8 100644 --- a/committing.rst +++ b/committing.rst @@ -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 ''''''''''''''' @@ -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 --------------- From ab07aefacd8fe48be55c2bbf40a67c4899be9973 Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Sat, 11 Mar 2017 11:55:34 -0800 Subject: [PATCH 12/19] using internal refs when available" --- pullrequest.rst | 36 +++++++++++++++--------------------- 1 file changed, 15 insertions(+), 21 deletions(-) diff --git a/pullrequest.rst b/pullrequest.rst index 18a62e438..497c2b25f 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -93,6 +93,8 @@ command (after any successful build of Python):: python.bat Tools/scripts/patchcheck.py +.. _pullrequest-quickguide: + Quick Guide ''''''''''' @@ -103,47 +105,39 @@ Here is a quick overview of you can contribute to CPython on GitHub: 1. If an Issue doesn't exist, `create an Issue`_ that describes your change -2. `Get started`_ and set up your system +2. Prepare your system by :ref:`setup` 3. Fork `CPython`_ on GitHub (using the Fork button in the upper-right on GitHub) -4. `Compile Python`_ on your system - -5. `Run tests`_ after you have built Python +4. Start :ref:`compiling` to build Python -6. `Add an "upstream" Git remote`_ on your system (for SSH, or you can `use HTTPS`_) +5. Begin :ref:`runtests` after you have built Python -7. `Create a Branch in Git`_ where you can work on changes +6. Set your Git :ref:`remote-configuration` to add an "upstream" remote (using SSH, or you can `use HTTPS`_) -8. `Run tests`_ again +7. Create :ref:`committing-active-branches` in Git where you can work on changes -9. Commit changes and `resolve conflicts in Git`_ +8. Continue :ref:`runtests` -10. `Push commits`_ to your GitHub repo +9. Prepare for :ref:`committing-push-changes` to your GitHub repo -11. `Create Pull Request`_ for your changes to be reviewed then merged into `CPython`_ +10. `Create Pull Request`_ for your changes to be reviewed then merged into `CPython`_ -12. Review and address `comments on your Pull Request`_ +11. Review and address `comments on your Pull Request`_ -13. When your changes are merged, celebrate contributing to Python! :) +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/ -.. _Get started: https://cpython-devguide.readthedocs.io/setup.html#getting-started .. _CPython: https://github.com/python/cpython -.. _Compile Python: https://cpython-devguide.readthedocs.io/setup.html#compiling-for-debugging -.. _Run tests: https://cpython-devguide.readthedocs.io/runtests.html#running-writing-tests -.. _Add an "upstream" Git remote: https://cpython-devguide.readthedocs.io/committing.html#remotes-setup .. _use HTTPS: https://help.github.com/articles/which-remote-url-should-i-use/ -.. _Create a Branch in Git: https://cpython-devguide.readthedocs.io/committing.html#active-branches -.. _resolve conflicts in Git: https://cpython-devguide.readthedocs.io/committing.html#squashing-commits -.. _Run tests: https://cpython-devguide.readthedocs.io/runtests.html#running-writing-tests -.. _Push commits: https://cpython-devguide.readthedocs.io/committing.html#pushing-changes .. _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 '''''''''''''''''''''''' @@ -151,7 +145,7 @@ Set up your system:: git clone git@github.com:YOUR_GITHUB_ID/cpython.git -Replace **YOUR_GITHUB_ID** with your GitHub account name above, then add upstream:: +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 From cebd3496d1ccd1e79e56667fb802d100a420e4dd Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Sat, 11 Mar 2017 11:56:17 -0800 Subject: [PATCH 13/19] swaping feature for branch --- pullrequest.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/pullrequest.rst b/pullrequest.rst index 497c2b25f..f5bd3e070 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -151,7 +151,7 @@ Replace **YOUR_GITHUB_ID** with your GitHub account name above, then add upstrea Work on new features or fixes:: - git checkout -b MY_NEW_FEATURE upstream/master + git checkout -b MY_BRANCH_NAME upstream/master As you work, please create a separate commit for each bug fix or feature change:: @@ -167,9 +167,9 @@ Use rebase -i to verify what you commit and squish small commits:: Then push your work to your clone on GitHub:: - git push origin MY_NEW_FEATURE + git push origin MY_BRANCH_NAME -When you're ready, make a Pull Request on GitHub and refer to your branch named **MY_NEW_FEATURE**. +When you're ready, make a Pull Request on GitHub and refer to your branch named **MY_BRANCH_NAME**. *Though submitting a Pull Request on GitHub is the preferred method of contribution, you can alternatively upload a patch to bugs.python.org* From 2b468f761a94b237ce6b1a73d12583507fda4e84 Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Sat, 11 Mar 2017 11:59:47 -0800 Subject: [PATCH 14/19] clarifying squishing and prs --- pullrequest.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/pullrequest.rst b/pullrequest.rst index f5bd3e070..a479426a6 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -153,7 +153,7 @@ Work on new features or fixes:: git checkout -b MY_BRANCH_NAME upstream/master -As you work, please create a separate commit for each bug fix or feature change:: +As you work, commit changes:: git commit @@ -161,15 +161,11 @@ Then fetch upstream to see if anything conflicts with your changes:: git fetch upstream -Use rebase -i to verify what you commit and squish small commits:: - - git rebase -i upstream/master - Then push your work to your clone on GitHub:: git push origin MY_BRANCH_NAME -When you're ready, make a Pull Request on GitHub and refer to your branch named **MY_BRANCH_NAME**. +When you're ready, make a Pull Request on GitHub from your changes in **MY_BRANCH_NAME**. *Though submitting a Pull Request on GitHub is the preferred method of contribution, you can alternatively upload a patch to bugs.python.org* From 36eb29b0392504fd6cf73f213e7cedda7f906c42 Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Sat, 11 Mar 2017 12:10:00 -0800 Subject: [PATCH 15/19] alt, submit patch to bpo --- pullrequest.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/pullrequest.rst b/pullrequest.rst index a479426a6..64da2970a 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -165,9 +165,11 @@ Then push your work to your clone on GitHub:: git push origin MY_BRANCH_NAME -When you're ready, make a Pull Request on GitHub from your changes in **MY_BRANCH_NAME**. +Make a Pull Request on GitHub from your changes in **MY_BRANCH_NAME**. -*Though submitting a Pull Request on GitHub is the preferred method of contribution, you can alternatively upload a patch to bugs.python.org* +.. note:: + You can upload a patch to https://bugs.python.org/, but Pull Requests + on GitHub are preferred. Licensing From 1ae31e56f7e2ca0b095322976968956c7120b870 Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Sat, 11 Mar 2017 13:16:52 -0800 Subject: [PATCH 16/19] added ssh https ref --- pullrequest.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pullrequest.rst b/pullrequest.rst index 64da2970a..72ba87e75 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -141,7 +141,7 @@ Here is a quick overview of you can contribute to CPython on GitHub: Quick Guide Step-by-step '''''''''''''''''''''''' -Set up your system:: +Set up your system (using SSH, or you can `use HTTPS`_):: git clone git@github.com:YOUR_GITHUB_ID/cpython.git From 9865ccfee5915ce013eb603d8d2b1a5bc8eff478 Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Thu, 23 Mar 2017 16:46:19 -0700 Subject: [PATCH 17/19] review adds to guide --- pullrequest.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/pullrequest.rst b/pullrequest.rst index 72ba87e75..881d58eba 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -105,23 +105,23 @@ Here is a quick overview of you can contribute to CPython on GitHub: 1. If an Issue doesn't exist, `create an Issue`_ that describes your change -2. Prepare your system by :ref:`setup` +2. :ref:`Get started `_ and set up your system 3. Fork `CPython`_ on GitHub (using the Fork button in the upper-right on GitHub) -4. Start :ref:`compiling` to build Python +4. :ref:`Build Python `_ on your system -5. Begin :ref:`runtests` after you have built Python +5. :ref:`Run tests `_ after you have built Python -6. Set your Git :ref:`remote-configuration` to add an "upstream" remote (using SSH, or you can `use HTTPS`_) +6. :ref:`Add an "upstream" Remote in Git `_ (using SSH, or you can `use HTTPS`_) -7. Create :ref:`committing-active-branches` in Git where you can work on changes +7. :ref:`Create a Branch in Git `_ `Create a Branch in Git`_ where you can work on changes -8. Continue :ref:`runtests` +8. :ref:`Run tests `_ again -9. Prepare for :ref:`committing-push-changes` to your GitHub repo +9. :ref:`Push commits `_ to your Github repo -10. `Create Pull Request`_ for your changes to be reviewed then merged into `CPython`_ +10. `Create Pull Request`_ in Github to merge a branch from your Fork 11. Review and address `comments on your Pull Request`_ From 2a7bb103e24505031c8609016898475316a9a666 Mon Sep 17 00:00:00 2001 From: Louis Rawlins Date: Fri, 24 Mar 2017 10:20:23 -0700 Subject: [PATCH 18/19] proper rst refs --- pullrequest.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/pullrequest.rst b/pullrequest.rst index 881d58eba..849d03fb6 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -105,21 +105,21 @@ Here is a quick overview of 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 `_ and set up your system +2. :ref:`Get started ` and set up your system 3. Fork `CPython`_ on GitHub (using the Fork button in the upper-right on GitHub) -4. :ref:`Build Python `_ on your system +4. :ref:`Build Python ` on your system -5. :ref:`Run tests `_ after you have built Python +5. :ref:`Run tests ` after you have built Python -6. :ref:`Add an "upstream" Remote in Git `_ (using SSH, or you can `use HTTPS`_) +6. :ref:`Add an "upstream" Remote in Git ` (using SSH, or you can `use HTTPS`_) -7. :ref:`Create a Branch in Git `_ `Create a Branch in Git`_ where you can work on changes +7. :ref:`Create a Branch in Git ` where you can work on changes -8. :ref:`Run tests `_ again +8. :ref:`Run tests ` again -9. :ref:`Push commits `_ to your Github repo +9. :ref:`Push commits ` to your Github repo 10. `Create Pull Request`_ in Github to merge a branch from your Fork From a37d2e672464530bcbd9e31d007b4191f3aecbae Mon Sep 17 00:00:00 2001 From: Mariatta Date: Wed, 12 Apr 2017 14:56:31 -0700 Subject: [PATCH 19/19] Add a missing word --- pullrequest.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pullrequest.rst b/pullrequest.rst index 849d03fb6..d8a7e87b0 100644 --- a/pullrequest.rst +++ b/pullrequest.rst @@ -101,7 +101,7 @@ Quick Guide `Clear communication`_ is key to contributing to any project, especially an `Open Source`_ project like Python. -Here is a quick overview of you can contribute to CPython on GitHub: +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