From db9404f69fe93c7f95ce9ddf5c8a44ea093ae705 Mon Sep 17 00:00:00 2001 From: johnslavik Date: Tue, 14 Apr 2026 11:52:15 +0200 Subject: [PATCH 1/7] 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. --- getting-started/pull-request-lifecycle.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/getting-started/pull-request-lifecycle.rst b/getting-started/pull-request-lifecycle.rst index d1f7e26a52..5dd4ccf437 100644 --- a/getting-started/pull-request-lifecycle.rst +++ b/getting-started/pull-request-lifecycle.rst @@ -260,6 +260,27 @@ See also `python/cpython#126133 `__. +.. _typo-fixes: + +Typo fixes +========== + +Fixing typos and grammatical errors is a welcome contribution. The most +appropriate places for such fixes are: + +* The ``Doc/`` directory (end-user documentation) +* Internal documentation, such as files in ``Misc/`` +* News entries under ``Misc/NEWS.d/`` + +Typo fixes in source code docstrings and comments are also acceptable. + +When submitting typo fixes, keep PRs **small and focused** — ideally one file +or a small set of closely related files. Large PRs that touch many unrelated +files across the repository create a significant review and notification burden +on maintainers, making them harder to process. Such PRs may be closed, and +contributors will be asked to resubmit as smaller, focused PRs. + + .. _patchcheck: ``patchcheck`` From eeef7782ea8d2c200bc63f25a38c4dddb5d78f16 Mon Sep 17 00:00:00 2001 From: johnslavik Date: Wed, 15 Apr 2026 12:02:09 +0200 Subject: [PATCH 2/7] 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 --- getting-started/pull-request-lifecycle.rst | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/getting-started/pull-request-lifecycle.rst b/getting-started/pull-request-lifecycle.rst index 5dd4ccf437..aa2c43dedf 100644 --- a/getting-started/pull-request-lifecycle.rst +++ b/getting-started/pull-request-lifecycle.rst @@ -265,20 +265,18 @@ See also `python/cpython#126133 Typo fixes ========== -Fixing typos and grammatical errors is a welcome contribution. The most -appropriate places for such fixes are: +Fixing typos and grammatical errors in documentation is a welcome +contribution. The most appropriate places for such fixes are: * The ``Doc/`` directory (end-user documentation) * Internal documentation, such as files in ``Misc/`` * News entries under ``Misc/NEWS.d/`` -Typo fixes in source code docstrings and comments are also acceptable. - -When submitting typo fixes, keep PRs **small and focused** — ideally one file -or a small set of closely related files. Large PRs that touch many unrelated -files across the repository create a significant review and notification burden -on maintainers, making them harder to process. Such PRs may be closed, and -contributors will be asked to resubmit as smaller, focused PRs. +Keep typo-fix PRs **small and focused**, ideally limited to one file or a +small set of closely related files. Large PRs that touch many unrelated files +notify a large number of reviewers unnecessarily and are harder to review. +Large typo-fix PRs, or PRs touching directories outside those listed above, +may be closed with a reference to this section. .. _patchcheck: From 09c68d2035a0a3d17fecabec6b4b92df36e16ae4 Mon Sep 17 00:00:00 2001 From: johnslavik Date: Wed, 15 Apr 2026 12:07:57 +0200 Subject: [PATCH 3/7] gh-1448: Add PR size guidance to 'Making good PRs' section --- getting-started/pull-request-lifecycle.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/getting-started/pull-request-lifecycle.rst b/getting-started/pull-request-lifecycle.rst index aa2c43dedf..9a04e32bd8 100644 --- a/getting-started/pull-request-lifecycle.rst +++ b/getting-started/pull-request-lifecycle.rst @@ -238,6 +238,11 @@ should do to help ensure that your pull request is accepted. changes, because there might be interferences unknown to you between your changes and some other part of the interpreter. +#. **Keep your pull request focused and small.** A pull request should address + one issue or add one feature. Combining multiple unrelated changes makes a + pull request harder to review and increases the number of people notified + unnecessarily. When in doubt, split into separate pull requests. + #. Proper :ref:`documentation ` additions/changes should be included. From 3f2b0451201fa904d7d929adfac33549843379b1 Mon Sep 17 00:00:00 2001 From: johnslavik Date: Wed, 15 Apr 2026 12:17:45 +0200 Subject: [PATCH 4/7] gh-1448: Note that typo fixes do not require a linked issue --- getting-started/pull-request-lifecycle.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/getting-started/pull-request-lifecycle.rst b/getting-started/pull-request-lifecycle.rst index 9a04e32bd8..1cb6c8101a 100644 --- a/getting-started/pull-request-lifecycle.rst +++ b/getting-started/pull-request-lifecycle.rst @@ -271,7 +271,8 @@ Typo fixes ========== Fixing typos and grammatical errors in documentation is a welcome -contribution. The most appropriate places for such fixes are: +contribution that does not require a linked issue. The most appropriate +places for such fixes are: * The ``Doc/`` directory (end-user documentation) * Internal documentation, such as files in ``Misc/`` From 1fea9c6bf77951a3ae310db3ee574729d6995edb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bartosz=20S=C5=82awecki?= Date: Mon, 20 Apr 2026 03:56:09 +0200 Subject: [PATCH 5/7] Apply suggestions from review Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Carol Willing --- getting-started/pull-request-lifecycle.rst | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/getting-started/pull-request-lifecycle.rst b/getting-started/pull-request-lifecycle.rst index 1cb6c8101a..b54af2e7f4 100644 --- a/getting-started/pull-request-lifecycle.rst +++ b/getting-started/pull-request-lifecycle.rst @@ -241,7 +241,7 @@ should do to help ensure that your pull request is accepted. #. **Keep your pull request focused and small.** A pull request should address one issue or add one feature. Combining multiple unrelated changes makes a pull request harder to review and increases the number of people notified - unnecessarily. When in doubt, split into separate pull requests. + unnecessarily. #. Proper :ref:`documentation ` additions/changes should be included. @@ -270,16 +270,12 @@ See also `python/cpython#126133 Typo fixes ========== -Fixing typos and grammatical errors in documentation is a welcome +Fixing typos and grammatical errors in documentation is a contribution that does not require a linked issue. The most appropriate -places for such fixes are: +place for such fixes is the :cpy-file:`Doc/` directory (end-user documentation). -* The ``Doc/`` directory (end-user documentation) -* Internal documentation, such as files in ``Misc/`` -* News entries under ``Misc/NEWS.d/`` -Keep typo-fix PRs **small and focused**, ideally limited to one file or a -small set of closely related files. Large PRs that touch many unrelated files +Keep typo-fix PRs **small and focused**. Large PRs that touch many unrelated files notify a large number of reviewers unnecessarily and are harder to review. Large typo-fix PRs, or PRs touching directories outside those listed above, may be closed with a reference to this section. From b7c7e01018f5cc8291583b98947fd39691398ed5 Mon Sep 17 00:00:00 2001 From: johnslavik Date: Mon, 20 Apr 2026 04:03:51 +0200 Subject: [PATCH 6/7] Reference the `typo fixes` section --- getting-started/pull-request-lifecycle.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/getting-started/pull-request-lifecycle.rst b/getting-started/pull-request-lifecycle.rst index b54af2e7f4..ce0cbce70e 100644 --- a/getting-started/pull-request-lifecycle.rst +++ b/getting-started/pull-request-lifecycle.rst @@ -27,7 +27,9 @@ Quick guide Here is a quick overview of how you can contribute to CPython: -#. `Create an issue`_ that describes your change [*]_ +#. `Create an issue`_ that describes your change. If it is trivial + (like :ref:`typo fixes `), or an issue already exists, + you can skip this step. #. :ref:`Create a new branch in Git ` from the ``main`` branch @@ -51,9 +53,6 @@ Here is a quick overview of how you can contribute to CPython: #. Celebrate contributing to CPython! :) -.. [*] If an issue is trivial (for example, typo fixes), or if an issue already exists, - you can skip this step. - Don't force-push ---------------- From 8bff5d2ddcdf3dcabb4fcbbcd9eb5fb022a0f6a6 Mon Sep 17 00:00:00 2001 From: johnslavik Date: Mon, 20 Apr 2026 04:06:05 +0200 Subject: [PATCH 7/7] Mention `InternalDocs/` --- getting-started/pull-request-lifecycle.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/getting-started/pull-request-lifecycle.rst b/getting-started/pull-request-lifecycle.rst index ce0cbce70e..3c93609f20 100644 --- a/getting-started/pull-request-lifecycle.rst +++ b/getting-started/pull-request-lifecycle.rst @@ -271,7 +271,8 @@ Typo fixes Fixing typos and grammatical errors in documentation is a contribution that does not require a linked issue. The most appropriate -place for such fixes is the :cpy-file:`Doc/` directory (end-user documentation). +place for such fixes are the :cpy-file:`Doc/` (end-user documentation) +and :cpy-file:`InternalDocs/` directories. Keep typo-fix PRs **small and focused**. Large PRs that touch many unrelated files