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

Skip to content

Commit ab07aef

Browse files
committed
using internal refs when available"
1 parent a6b773c commit ab07aef

File tree

1 file changed

+15
-21
lines changed

1 file changed

+15
-21
lines changed

pullrequest.rst

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ command (after any successful build of Python)::
9393
python.bat Tools/scripts/patchcheck.py
9494

9595

96+
.. _pullrequest-quickguide:
97+
9698
Quick Guide
9799
'''''''''''
98100

@@ -103,55 +105,47 @@ Here is a quick overview of you can contribute to CPython on GitHub:
103105

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

106-
2. `Get started`_ and set up your system
108+
2. Prepare your system by :ref:`setup`
107109

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

110-
4. `Compile Python`_ on your system
111-
112-
5. `Run tests`_ after you have built Python
112+
4. Start :ref:`compiling` to build Python
113113

114-
6. `Add an "upstream" Git remote`_ on your system (for SSH, or you can `use HTTPS`_)
114+
5. Begin :ref:`runtests` after you have built Python
115115

116-
7. `Create a Branch in Git`_ where you can work on changes
116+
6. Set your Git :ref:`remote-configuration` to add an "upstream" remote (using SSH, or you can `use HTTPS`_)
117117

118-
8. `Run tests`_ again
118+
7. Create :ref:`committing-active-branches` in Git where you can work on changes
119119

120-
9. Commit changes and `resolve conflicts in Git`_
120+
8. Continue :ref:`runtests`
121121

122-
10. `Push commits`_ to your GitHub repo
122+
9. Prepare for :ref:`committing-push-changes` to your GitHub repo
123123

124-
11. `Create Pull Request`_ for your changes to be reviewed then merged into `CPython`_
124+
10. `Create Pull Request`_ for your changes to be reviewed then merged into `CPython`_
125125

126-
12. Review and address `comments on your Pull Request`_
126+
11. Review and address `comments on your Pull Request`_
127127

128-
13. When your changes are merged, celebrate contributing to Python! :)
128+
12. When your changes are merged, celebrate contributing to Python! :)
129129

130130
.. _Clear communication: https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution
131131
.. _Open Source: https://opensource.guide/
132132
.. _create an Issue: https://bugs.python.org/
133-
.. _Get started: https://cpython-devguide.readthedocs.io/setup.html#getting-started
134133
.. _CPython: https://github.com/python/cpython
135-
.. _Compile Python: https://cpython-devguide.readthedocs.io/setup.html#compiling-for-debugging
136-
.. _Run tests: https://cpython-devguide.readthedocs.io/runtests.html#running-writing-tests
137-
.. _Add an "upstream" Git remote: https://cpython-devguide.readthedocs.io/committing.html#remotes-setup
138134
.. _use HTTPS: https://help.github.com/articles/which-remote-url-should-i-use/
139-
.. _Create a Branch in Git: https://cpython-devguide.readthedocs.io/committing.html#active-branches
140-
.. _resolve conflicts in Git: https://cpython-devguide.readthedocs.io/committing.html#squashing-commits
141-
.. _Run tests: https://cpython-devguide.readthedocs.io/runtests.html#running-writing-tests
142-
.. _Push commits: https://cpython-devguide.readthedocs.io/committing.html#pushing-changes
143135
.. _Create Pull Request: https://help.github.com/articles/creating-a-pull-request/
144136
.. _comments on your Pull Request: https://help.github.com/articles/commenting-on-a-pull-request/
145137

146138

139+
.. _pullrequest-steps:
140+
147141
Quick Guide Step-by-step
148142
''''''''''''''''''''''''
149143

150144
Set up your system::
151145

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

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

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

0 commit comments

Comments
 (0)