Skip to content

Add a section to the PR guide on how to write good titles and descriptions #1845

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

Open
sirosen wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add a section to the PR guide on how to write good titles and descriptions #1845

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
099ddc5
Add section to PR guide on titles and descriptions
sirosen Jun 26, 2026
5e6548c
Update getting-started/pull-request-lifecycle.rst
sirosen Jun 26, 2026
cc60068
Move "good-pull-request-metadata" section down
sirosen Jun 27, 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
Prev Previous commit
Next Next commit
Update getting-started/pull-request-lifecycle.rst 
Co-authored-by: Stan Ulbrych <stan@python.org>
  • Loading branch information
@sirosen @StanFromIreland
sirosen and StanFromIreland authored Jun 26, 2026
commit 5e6548c19fc716ca27486c9f0d587dfe75059d6c
4 changes: 2 additions & 2 deletions getting-started/pull-request-lifecycle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,8 +210,8 @@ Reviewers want to be able to understand roughly what your pull request does
before reading the changes.

The title should be a sentence or phrase in the imperative which says what the
pull request does in short form. It should start with ``gh-NNNNNN:``, for pull
requests which close open issues.
pull request does in short form. Pull requests attached to issues should
be linked by putting the issue number in the title (``gh-NNNNNN:``).
For example, ``gh-12345: Fix bug when spam module is served with eggs``.
Comment thread
StanFromIreland marked this conversation as resolved.
Outdated

The pull request description field should be a detailed summary.
Expand Down
Loading