Skip to content

Mention typo fixes and large PRs #1782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
willingc merged 7 commits into from
Apr 20, 2026
Merged

Mention typo fixes and large PRs #1782

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
db9404f
gh-1448: Add section on typo fixes and large PRs
johnslavik Apr 14, 2026
eeef778
gh-1448: Revise typo fixes section for clarity
johnslavik Apr 15, 2026
09c68d2
gh-1448: Add PR size guidance to 'Making good PRs' section
johnslavik Apr 15, 2026
3f2b045
gh-1448: Note that typo fixes do not require a linked issue
johnslavik Apr 15, 2026
1fea9c6
Apply suggestions from review
johnslavik Apr 20, 2026
b7c7e01
Reference the `typo fixes` section
johnslavik Apr 20, 2026
8bff5d2
Mention `InternalDocs/`
johnslavik Apr 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions getting-started/pull-request-lifecycle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <typo-fixes>`), or an issue already exists,
you can skip this step.

#. :ref:`Create a new branch in Git <pullrequest-steps>` from the
``main`` branch
Expand All @@ -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
----------------

Expand Down Expand Up @@ -238,6 +237,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.

#. Proper :ref:`documentation <documenting>` additions/changes should be included.


Expand All @@ -260,6 +264,23 @@ See also `python/cpython#126133
<https://github.com/python/cpython/issues/126133#issuecomment-2460824052>`__.


.. _typo-fixes:
Comment thread
johnslavik marked this conversation as resolved.

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 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
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:

``patchcheck``
Expand Down
Loading