Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork931
Update pull-request-lifecycle.rst with creating PR title and descriptions (#931)#1626
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Updated the "making a good PR" section of the page with tips on creating the title and description
python-cla-botbot commentedAug 9, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
| issue resolution. It is the initial point of contact in a code review, and | ||
| allows the code reviewer to quickly assess the issue. The suggested formatting | ||
| of the title and description is | ||
| **[type(optional) title: description (issue number)]** where type is the label |
StanFromIrelandAug 9, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I don't understand this, where is thegh-XXXXX, and what is type?
An example title:
GH-132732: Use pure op machinery to optimize various instructions with
_POP_TOPand_POP_TWO
Updated the title formatting, and provided an example. Also removed trailing whitespaces.
pythonGH-931: Update pull-request-lifecycle.rst PR title and description section
| Here is an example of a poor and revised pull request description: | ||
| **Poor Pull Request:** "update code" **Revised Pull Request:** | ||
| "feat: add search functionality to user dashboard(closes #111)" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This has the same issue I mentioned above (which was correct).
Uh oh!
There was an error while loading.Please reload this page.
Updated the "making a good PR" section of the page with tips on creating the title and description
#931📚 Documentation preview 📚:https://cpython-devguide--1626.org.readthedocs.build/