|
4 | 4 | Pull request lifecycle |
5 | 5 | ====================== |
6 | 6 |
|
7 | | -.. important:: |
8 | 7 |
|
9 | | - |draft| |
| 8 | +Making Good Pull Requests |
| 9 | +========================= |
10 | 10 |
|
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. |
12 | 18 |
|
| 19 | + **Example:** |
| 20 | + **Good Title**: "GH-931: Enforce imperative tense in PR titles" |
| 21 | + **Bad Title**: "Updating docs" |
13 | 22 |
|
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** |
20 | 24 |
|
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