Skip to content

Commit eeef778

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

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

getting-started/pull-request-lifecycle.rst

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -265,20 +265,18 @@ See also `python/cpython#126133
265265
Typo fixes
266266
==========
267267

268-
Fixing typos and grammatical errors is a welcome contribution. The most
269-
appropriate places for such fixes are:
268+
Fixing typos and grammatical errors in documentation is a welcome
269+
contribution. The most appropriate places for such fixes are:
270270

271271
* The ``Doc/`` directory (end-user documentation)
272272
* Internal documentation, such as files in ``Misc/``
273273
* News entries under ``Misc/NEWS.d/``
274274

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.
275+
Keep typo-fix PRs **small and focused**, ideally limited to one file or a
276+
small set of closely related files. Large PRs that touch many unrelated files
277+
notify a large number of reviewers unnecessarily and are harder to review.
278+
Large typo-fix PRs, or PRs touching directories outside those listed above,
279+
may be closed with a reference to this section.
282280

283281

284282
.. _patchcheck:

0 commit comments

Comments
 (0)