Skip to content

Commit db9404f

Browse files
committed
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.
1 parent caeafb2 commit db9404f

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

getting-started/pull-request-lifecycle.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,27 @@ See also `python/cpython#126133
260260
<https://github.com/python/cpython/issues/126133#issuecomment-2460824052>`__.
261261

262262

263+
.. _typo-fixes:
264+
265+
Typo fixes
266+
==========
267+
268+
Fixing typos and grammatical errors is a welcome contribution. The most
269+
appropriate places for such fixes are:
270+
271+
* The ``Doc/`` directory (end-user documentation)
272+
* Internal documentation, such as files in ``Misc/``
273+
* News entries under ``Misc/NEWS.d/``
274+
275+
Typo fixes in source code docstrings and comments are also acceptable.
276+
277+
When submitting typo fixes, keep PRs **small and focused** — ideally one file
278+
or a small set of closely related files. Large PRs that touch many unrelated
279+
files across the repository create a significant review and notification burden
280+
on maintainers, making them harder to process. Such PRs may be closed, and
281+
contributors will be asked to resubmit as smaller, focused PRs.
282+
283+
263284
.. _patchcheck:
264285

265286
``patchcheck``

0 commit comments

Comments
 (0)