Skip to content
Open
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions getting-started/pull-request-lifecycle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
unnecessarily. When in doubt, split into separate pull requests.
unnecessarily.


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


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


.. _typo-fixes:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean to reference the section somewhere?


Typo fixes
==========

Fixing typos and grammatical errors in documentation is a welcome
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

* 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
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.
Comment on lines +275 to +285
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
places for such fixes are:
* 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
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.
place for such fixes is the ``Doc/`` directory (end-user documentation).
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.

Copy link
Copy Markdown
Member

@StanFromIreland StanFromIreland Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO we can also include InternalDocs.

Copy link
Copy Markdown
Collaborator

@willingc willingc Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was on the fence about InternalDocs. No objection about keeping it in.



.. _patchcheck:

``patchcheck``
Expand Down
Loading