Skip to content

Commit 1cda41a

Browse files
johnslavikwillingc
andauthored
Mention typo fixes and large PRs (#1782)
* gh-1448: Add section on typo fixes and large PRs Add guidance on keeping typo-fix PRs small and focused, listing appropriate directories (Doc/, Misc/, Misc/NEWS.d/) and noting that large sweeping PRs may be closed. * gh-1448: Revise typo fixes section for clarity - Clarify which directories are appropriate for typo fixes - Encourage small, focused PRs to reduce reviewer notification burden - Explicitly note that large PRs or PRs outside listed directories may be closed with a reference to this section * gh-1448: Add PR size guidance to 'Making good PRs' section * gh-1448: Note that typo fixes do not require a linked issue * Apply suggestions from review Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> * Reference the `typo fixes` section * Mention `InternalDocs/` --------- Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
1 parent 7bd59d1 commit 1cda41a

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

getting-started/pull-request-lifecycle.rst

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ Quick guide
2727

2828
Here is a quick overview of how you can contribute to CPython:
2929

30-
#. `Create an issue`_ that describes your change [*]_
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.
3133

3234
#. :ref:`Create a new branch in Git <pullrequest-steps>` from the
3335
``main`` branch
@@ -51,9 +53,6 @@ Here is a quick overview of how you can contribute to CPython:
5153

5254
#. Celebrate contributing to CPython! :)
5355

54-
.. [*] If an issue is trivial (for example, typo fixes), or if an issue already exists,
55-
you can skip this step.
56-
5756
Don't force-push
5857
----------------
5958

@@ -238,6 +237,11 @@ should do to help ensure that your pull request is accepted.
238237
changes, because there might be interferences unknown to you between your
239238
changes and some other part of the interpreter.
240239

240+
#. **Keep your pull request focused and small.** A pull request should address
241+
one issue or add one feature. Combining multiple unrelated changes makes a
242+
pull request harder to review and increases the number of people notified
243+
unnecessarily.
244+
241245
#. Proper :ref:`documentation <documenting>` additions/changes should be included.
242246

243247
.. _news-entry:
@@ -359,6 +363,23 @@ See also `python/cpython#126133
359363
<https://github.com/python/cpython/issues/126133#issuecomment-2460824052>`__.
360364

361365

366+
.. _typo-fixes:
367+
368+
Typo fixes
369+
==========
370+
371+
Fixing typos and grammatical errors in documentation is a
372+
contribution that does not require a linked issue. The most appropriate
373+
place for such fixes are the :cpy-file:`Doc/` (end-user documentation)
374+
and :cpy-file:`InternalDocs/` directories.
375+
376+
377+
Keep typo-fix PRs **small and focused**. Large PRs that touch many unrelated files
378+
notify a large number of reviewers unnecessarily and are harder to review.
379+
Large typo-fix PRs, or PRs touching directories outside those listed above,
380+
may be closed with a reference to this section.
381+
382+
362383
.. _patchcheck:
363384

364385
``patchcheck``

0 commit comments

Comments
 (0)