Skip to content

Improve PR title guidelines in "Making good PRs" section #1773

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
Shashank01177 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve PR title guidelines in "Making good PRs" section #1773

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions getting-started/pull-request-lifecycle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,12 @@ Making good PRs
When creating a pull request for submission, there are several things that you
should do to help ensure that your pull request is accepted.

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".
- Use clear and descriptive titles
- Mention the affected module or feature
- Avoid generic phrases like "fix issue"
- Keep titles concise but informative

#. **Make your change against the right version of Python.** In general all
changes are made against the ``main`` branch first. This includes bug fixes.
After the change is merged there, it will be :ref:`ported back <branch-merge>`
Expand Down
Loading