Skip to content

Commit 608a224

Browse files
sirosenhugovk
andauthored
Apply suggestions from code review
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
1 parent 1931332 commit 608a224

1 file changed

Lines changed: 13 additions & 10 deletions

File tree

getting-started/quick-reference.rst

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
Quick reference
55
===============
66

7+
.. include:: /include/activate-tab.rst
8+
79
Here are the basic steps needed to get set up and open a pull request.
810

911
This is meant as a checklist and cheat-sheet, not a comprehensive guide.
@@ -135,7 +137,7 @@ For example:
135137
136138
gh-12345: Fix some bug in spam module
137139
138-
See also, GitHub's documentation on `creating Pull Requests`_.
140+
See also, GitHub's documentation on `creating pull requests`_.
139141

140142
For more detailed guidance, follow the :ref:`step-by-step pull request guide <pullrequest-steps>`.
141143

@@ -145,24 +147,25 @@ For more detailed guidance, follow the :ref:`step-by-step pull request guide <pu
145147
Agreement (CLA) as described in the :ref:`Licensing <cla>` section of
146148
this guide.
147149

148-
.. _creating Pull Requests: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
150+
.. _creating pull requests: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
149151

150152
Work on your pull request
151153
-------------------------
152154

153-
Make sure the :ref:`continuous integration checks on your Pull
154-
Request are green <keeping-ci-green>` (successful).
155+
Make sure the :ref:`continuous integration checks on your pull
156+
request are green <keeping-ci-green>` (successful).
155157

156158
Read and respond to reviewer comments on your pull request.
157159

158-
See also, GitHub's documentation on `commenting on Pull Requests`_.
160+
See also, GitHub's documentation on `commenting on pull requests`_.
159161

160-
.. note::
162+
Don't force-push
163+
----------------
161164

162-
In order to keep the commit history intact, avoid squashing or amending
163-
history and then force-pushing to the PR.
164-
Reviewers often want to look at individual commits.
165+
In order to keep the commit history intact, avoid squashing or amending
166+
history and then force-pushing to the PR.
167+
Reviewers often want to look at individual commits.
165168

166-
CPython uses squash merges, so PRs will end up as single commits when merged.
169+
CPython uses squash merges, so PRs will end up as single commits when merged.
167170

168171
.. _commenting on Pull Requests: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request

0 commit comments

Comments
 (0)