Update pull-request-lifecycle.rst with creating PR title and descriptions (#931) #1626
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated the "making a good PR" section of the page with tips on creating the title and description
|
All commit authors signed the Contributor License Agreement. |
| 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 |
There was a problem hiding this comment.
I don't understand this, where is the gh-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
Comment on lines
+232
to
+234
| 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.
This has the same issue I mentioned above (which was correct).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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/