Skip to content

Commit 9a62b60

Browse files
sirosensirosen
committed
Move the "quick reference" to a dedicated page
A new page at `Getting Started > Quick Reference` is added to contain the (moved) content which was in the Quick Reference section of the index document for the site. The content is left almost entirely untouched, but the introductory text is slightly altered to de-emphasize use of the doc for new contributors. Intentionally, as described in #1837, the page is placed in Getting Started but after the setup guide.
1 parent 24065f9 commit 9a62b60

3 files changed

Lines changed: 98 additions & 97 deletions

File tree

‎getting-started/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ Getting started
88
:maxdepth: 5
99

1010
setup-building
11+
quick-reference
1112
fixing-issues
1213
git-boot-camp
1314
pull-request-lifecycle

‎getting-started/quick-reference.rst‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
.. _quick-reference:
2+
3+
===============
4+
Quick Reference
5+
===============
6+
7+
Here are the basic steps needed to get set up and open a pull request.
8+
9+
This is meant as a checklist and cheat-sheet, not a comprehensive guide.
10+
For complete instructions please see the :ref:`setup guide <setup>`.
11+
12+
1. Install and set up :ref:`Git <vcsetup>` and other dependencies
13+
(see the :ref:`Git Setup <setup>` page for detailed information).
14+
15+
2. Fork `the CPython repository <https://github.com/python/cpython>`__
16+
to your GitHub account and :ref:`get the source code <checkout>` using::
17+
18+
git clone https://github.com/<your_username>/cpython
19+
cd cpython
20+
21+
3. Build Python:
22+
23+
.. tab:: Unix
24+
25+
.. code-block:: shell
26+
27+
./configure --config-cache --with-pydebug && make -j $(nproc)
28+
29+
.. tab:: macOS
30+
31+
.. code-block:: shell
32+
33+
./configure --config-cache --with-pydebug && make -j8
34+
35+
.. tab:: Windows
36+
37+
.. code-block:: dosbatch
38+
39+
PCbuild\build.bat -e -d
40+
41+
See also :ref:`more detailed instructions <compiling>`,
42+
:ref:`how to install and build dependencies <build-dependencies>`,
43+
and the platform-specific pages for :ref:`Unix <unix-compiling>`,
44+
:ref:`macOS <macOS>`, and :ref:`Windows <windows-compiling>`.
45+
46+
4. :ref:`Run the tests <runtests>`:
47+
48+
.. tab:: Unix
49+
50+
.. code-block:: shell
51+
52+
./python -m test -j3
53+
54+
.. tab:: macOS
55+
56+
.. code-block:: shell
57+
58+
./python.exe -m test -j8
59+
60+
.. note::
61+
:ref:`Most <mac-python.exe>` macOS systems use
62+
:file:`./python.exe` in order to avoid filename conflicts with
63+
the ``Python`` directory.
64+
65+
.. tab:: Windows
66+
67+
.. code-block:: dosbatch
68+
69+
.\python.bat -m test -j3
70+
71+
5. Create a new branch where your work for the issue will go, for example::
72+
73+
git checkout -b fix-issue-12345 main
74+
75+
If an issue does not already exist, please `create it
76+
<https://github.com/python/cpython/issues>`__. Trivial issues (for example, typos) do
77+
not require an issue.
78+
79+
6. Push the branch on your fork on GitHub and :ref:`create a pull request
80+
<pullrequest>`. Include the issue number using ``gh-NNNNNN`` in the
81+
pull request title. For example:
82+
83+
.. code-block:: text
84+
85+
gh-12345: Fix some bug in spam module
86+
87+
7. Add a News entry into the ``Misc/NEWS.d/`` directory as individual file. The
88+
news entry can be created by using `blurb-it <https://blurb-it.herokuapp.com/>`__,
89+
or the :pypi:`blurb` tool and its ``blurb add``
90+
command. Please read more about ``blurb`` in its
91+
`repository <https://github.com/python/blurb>`__.
92+
93+
.. note::
94+
95+
First time contributors will need to sign the Contributor Licensing
96+
Agreement (CLA) as described in the :ref:`Licensing <cla>` section of
97+
this guide.

‎index.rst‎

Lines changed: 0 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -74,103 +74,6 @@ For example,
7474
:width: 100%
7575

7676

77-
.. _quick-reference:
78-
79-
Quick reference
80-
---------------
81-
82-
Here are the basic steps needed to get set up and open a pull request.
83-
This is meant as a checklist, once you know the basics. For complete
84-
instructions please see the :ref:`setup guide <setup>`.
85-
86-
1. Install and set up :ref:`Git <vcsetup>` and other dependencies
87-
(see the :ref:`Git Setup <setup>` page for detailed information).
88-
89-
2. Fork `the CPython repository <https://github.com/python/cpython>`__
90-
to your GitHub account and :ref:`get the source code <checkout>` using::
91-
92-
git clone https://github.com/<your_username>/cpython
93-
cd cpython
94-
95-
3. Build Python:
96-
97-
.. tab:: Unix
98-
99-
.. code-block:: shell
100-
101-
./configure --config-cache --with-pydebug && make -j $(nproc)
102-
103-
.. tab:: macOS
104-
105-
.. code-block:: shell
106-
107-
./configure --config-cache --with-pydebug && make -j8
108-
109-
.. tab:: Windows
110-
111-
.. code-block:: dosbatch
112-
113-
PCbuild\build.bat -e -d
114-
115-
See also :ref:`more detailed instructions <compiling>`,
116-
:ref:`how to install and build dependencies <build-dependencies>`,
117-
and the platform-specific pages for :ref:`Unix <unix-compiling>`,
118-
:ref:`macOS <macOS>`, and :ref:`Windows <windows-compiling>`.
119-
120-
4. :ref:`Run the tests <runtests>`:
121-
122-
.. tab:: Unix
123-
124-
.. code-block:: shell
125-
126-
./python -m test -j3
127-
128-
.. tab:: macOS
129-
130-
.. code-block:: shell
131-
132-
./python.exe -m test -j8
133-
134-
.. note::
135-
:ref:`Most <mac-python.exe>` macOS systems use
136-
:file:`./python.exe` in order to avoid filename conflicts with
137-
the ``Python`` directory.
138-
139-
.. tab:: Windows
140-
141-
.. code-block:: dosbatch
142-
143-
.\python.bat -m test -j3
144-
145-
5. Create a new branch where your work for the issue will go, for example::
146-
147-
git checkout -b fix-issue-12345 main
148-
149-
If an issue does not already exist, please `create it
150-
<https://github.com/python/cpython/issues>`__. Trivial issues (for example, typos) do
151-
not require an issue.
152-
153-
6. Push the branch on your fork on GitHub and :ref:`create a pull request
154-
<pullrequest>`. Include the issue number using ``gh-NNNNNN`` in the
155-
pull request title. For example:
156-
157-
.. code-block:: text
158-
159-
gh-12345: Fix some bug in spam module
160-
161-
7. Add a News entry into the ``Misc/NEWS.d/`` directory as individual file. The
162-
news entry can be created by using `blurb-it <https://blurb-it.herokuapp.com/>`__,
163-
or the :pypi:`blurb` tool and its ``blurb add``
164-
command. Please read more about ``blurb`` in its
165-
`repository <https://github.com/python/blurb>`__.
166-
167-
.. note::
168-
169-
First time contributors will need to sign the Contributor Licensing
170-
Agreement (CLA) as described in the :ref:`Licensing <cla>` section of
171-
this guide.
172-
173-
17477
Proposing changes to Python itself
17578
----------------------------------
17679

0 commit comments

Comments
 (0)