@@ -93,6 +93,8 @@ command (after any successful build of Python)::
93
93
python.bat Tools/scripts/patchcheck.py
94
94
95
95
96
+ .. _pullrequest-quickguide :
97
+
96
98
Quick Guide
97
99
'''''''''''
98
100
@@ -103,55 +105,47 @@ Here is a quick overview of you can contribute to CPython on GitHub:
103
105
104
106
1. If an Issue doesn't exist, `create an Issue `_ that describes your change
105
107
106
- 2. ` Get started `_ and set up your system
108
+ 2. Prepare your system by :ref: ` setup `
107
109
108
110
3. Fork `CPython `_ on GitHub (using the Fork button in the upper-right on GitHub)
109
111
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
113
113
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
115
115
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 `_)
117
117
118
- 8 . ` Run tests `_ again
118
+ 7 . Create :ref: ` committing-active-branches ` in Git where you can work on changes
119
119
120
- 9 . Commit changes and ` resolve conflicts in Git `_
120
+ 8 . Continue :ref: ` runtests `
121
121
122
- 10. ` Push commits `_ to your GitHub repo
122
+ 9. Prepare for :ref: ` committing-push-changes ` to your GitHub repo
123
123
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 `_
125
125
126
- 12 . Review and address `comments on your Pull Request `_
126
+ 11 . Review and address `comments on your Pull Request `_
127
127
128
- 13 . When your changes are merged, celebrate contributing to Python! :)
128
+ 12 . When your changes are merged, celebrate contributing to Python! :)
129
129
130
130
.. _Clear communication : https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution
131
131
.. _Open Source : https://opensource.guide/
132
132
.. _create an Issue : https://bugs.python.org/
133
- .. _Get started : https://cpython-devguide.readthedocs.io/setup.html#getting-started
134
133
.. _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
138
134
.. _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
143
135
.. _Create Pull Request : https://help.github.com/articles/creating-a-pull-request/
144
136
.. _comments on your Pull Request : https://help.github.com/articles/commenting-on-a-pull-request/
145
137
146
138
139
+ .. _pullrequest-steps :
140
+
147
141
Quick Guide Step-by-step
148
142
''''''''''''''''''''''''
149
143
150
144
Set up your system::
151
145
152
146
git clone [email protected] :YOUR_GITHUB_ID/cpython.git
153
147
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 `_) ::
155
149
156
150
git remote add upstream git://github.com/python/cpython.git
157
151
0 commit comments