Skip to content

Commit 5e7e09e

Browse files
committed
Replace the PR quickguide with a link
Instead of a duplicate guide, we can now link to the canonical quick reference doc.
1 parent cdc0df0 commit 5e7e09e

2 files changed

Lines changed: 7 additions & 53 deletions

File tree

getting-started/pull-request-lifecycle.rst

Lines changed: 2 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -16,58 +16,8 @@ that you create a branch in Git, make your changes, push those changes
1616
to your fork on GitHub (``origin``), and then create a pull request against
1717
the official CPython repository (``upstream``).
1818

19-
20-
.. _pullrequest-quickguide:
21-
22-
Quick guide
23-
===========
24-
25-
`Clear communication`_ is key to contributing to any project, especially an
26-
`Open Source`_ project like CPython.
27-
28-
Here is a quick overview of how you can contribute to CPython:
29-
30-
#. `Create an issue`_ that describes your change. If it is trivial
31-
(like :ref:`typo fixes <typo-fixes>`), or an issue already exists,
32-
you can skip this step.
33-
34-
#. :ref:`Create a new branch in Git <pullrequest-steps>` from the
35-
``main`` branch
36-
37-
#. Work on changes: fix a bug or add a new feature
38-
39-
#. :ref:`Run tests <runtests>` and ``make patchcheck``
40-
41-
#. :ref:`Commit <commit-changes>` and :ref:`push <push-changes>`
42-
changes to your GitHub fork
43-
44-
#. `Create Pull Request`_ on GitHub to merge a branch from your fork
45-
46-
#. Make sure the :ref:`continuous integration checks on your Pull Request
47-
are green <keeping-ci-green>` (successful)
48-
49-
#. Review and address `comments on your Pull Request`_
50-
51-
#. When your changes are merged, you can :ref:`delete the PR branch
52-
<deleting_branches>`
53-
54-
#. Celebrate contributing to CPython! :)
55-
56-
Don't force-push
57-
----------------
58-
59-
In order to keep the commit history intact, please avoid squashing or amending
60-
history and then force-pushing to the PR. Reviewers often want to look at
61-
individual commits.
62-
When the PR is merged, everything will be squashed into a single commit.
63-
64-
.. _Clear communication: https://opensource.guide/how-to-contribute/#how-to-submit-a-contribution
65-
.. _Open Source: https://opensource.guide/
66-
.. _create an issue: https://github.com/python/cpython/issues
67-
.. _CPython: https://github.com/python/cpython
68-
.. _use HTTPS: https://help.github.com/articles/which-remote-url-should-i-use/
69-
.. _Create Pull Request: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
70-
.. _comments on your Pull Request: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request
19+
For a cheat-sheet reference, see the
20+
:ref:`quick reference on creating pull requests <pullrequest-quickguide>`.
7121

7222

7323
.. _pullrequest-steps:

getting-started/quick-reference.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ Run the tests
9393
See also :ref:`how to write and run tests <run-write-tests>`.
9494

9595

96+
.. _pullrequest-quickguide:
97+
9698
Create issues and pull requests
9799
===============================
98100

@@ -166,7 +168,9 @@ See also, GitHub's documentation on `commenting on Pull Requests`_.
166168

167169
.. note::
168170

169-
Don't force-push. Reviewers often want to look at individual commits.
171+
In order to keep the commit history intact, please avoid squashing or amending
172+
history and then force-pushing to the PR.
173+
Reviewers often want to look at individual commits.
170174

171175
CPython uses squash merges, so PRs will end up as single commits when merged.
172176

0 commit comments

Comments
 (0)