Skip to content

Commit 68ed3dc

Browse files
Improve PR title guidelines in "Making good PRs" section
Added guidance for writing clear and descriptive pull request titles in the "Making good PRs" section. This helps avoid vague titles and improves clarity for contributors.
1 parent d5194a0 commit 68ed3dc

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

getting-started/pull-request-lifecycle.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,12 @@ Making good PRs
195195
When creating a pull request for submission, there are several things that you
196196
should do to help ensure that your pull request is accepted.
197197

198+
A pull request should have a clear and descriptive title that accurately reflects the change being made. Avoid vague titles such as "fix bug" or "update code". Instead, use specific titles like "Fix incorrect module suggestion for -S option" or "Improve error handling in importlib".
199+
- Use clear and descriptive titles
200+
- Mention the affected module or feature
201+
- Avoid generic phrases like "fix issue"
202+
- Keep titles concise but informative
203+
198204
#. **Make your change against the right version of Python.** In general all
199205
changes are made against the ``main`` branch first. This includes bug fixes.
200206
After the change is merged there, it will be :ref:`ported back <branch-merge>`

0 commit comments

Comments
 (0)