Skip to content

Commit 5be5f9b

Browse files
committed
GH-931: Improve 'Making Good PRs' section with title guidelines
1 parent f489bdd commit 5be5f9b

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

contrib/doc/pull-request-lifecycle.rst

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,31 @@
44
Pull request lifecycle
55
======================
66

7-
.. important::
87

9-
|draft|
8+
Making Good Pull Requests
9+
=========================
1010

11-
|purpose|
11+
- **Title Format**: Use a concise, imperative verb phrase (e.g., "Fix typo in setup guide", not "Fixed typo").
12+
- Start with a verb (e.g., "Add", "Fix", "Improve").
13+
- Avoid vague terms like "Update" or "Change".
14+
- Include an issue reference (e.g., "GH-123: Fix ...").
15+
- **Description**: Explain the **what**, **why**, and **how**.
16+
- Reference related issues using ``GH-123`` or ``bpo-456``.
17+
- For complex changes, add a "Rationale" subsection.
1218

19+
**Example:**
20+
**Good Title**: "GH-931: Enforce imperative tense in PR titles"
21+
**Bad Title**: "Updating docs"
1322

14-
[Details of pull requests for documentation contributions. The existing
15-
:ref:`pull-request-lifecycle` page is long and includes many details.
16-
Some only apply to code contributions, but many are common to all
17-
contributions. Should we keep a common page, with documentation tweaks here, or
18-
should this page have only the documentation details even if they are duplicated
19-
elsewhere?]
23+
**Here is a checklist for contributors before submitting a PR**
2024

21-
[See :ref:`code-pull-request-lifecycle` for the code half of this conundrum.]
25+
Before submitting a PR:
26+
- [ ] Title follows the ``<Verb>: <Concise Summary>`` format.
27+
- [ ] Description explains the **purpose** and **impact**.
28+
- [ ] Linked to relevant issues (e.g., "Closes GH-123").
29+
- [ ] Tests or documentation updated (if applicable).
30+
31+
.. warning::
32+
Poorly titled PRs may be rejected or delayed. Maintainers rely on clear titles to track changes in the project’s history.
33+
34+
Keep calm and code on! 🚀

0 commit comments

Comments
 (0)