Add a section to general guidelines for a thorough pull request description #35
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
Ivorforce
force-pushed
the
contribute-pr-guidelines
branch
2 times, most recently
from
d9046ed to
8eda00f
Compare
Member
AThousandShips
left a comment
AThousandShips
left a comment
There was a problem hiding this comment.
I'd add a special note and link for performance PRs
Ivorforce
force-pushed
the
contribute-pr-guidelines
branch
from
8eda00f to
3c2d944
Compare
AThousandShips
approved these changes
Dec 2, 2025
Member
AThousandShips
left a comment
AThousandShips
left a comment
There was a problem hiding this comment.
I think this looks good and a great addition!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
I often see pull requests with inadequate description.
Some are especially egregious, with only one or two sentences for several hundreds of LOC changed. But even the more thorough ones often lack some component to really make it shine.
So I think a guideline for a thorough pull request description could be useful. We could link to it any time a contribution lacks a thorough enough description.
The text is inspired by the components of a research paper (abstract, motivation, state of the art, methods, results, discussion, future work). This is a tried-and-true method that's helping researchers connect and describe their complex work.
Of course, contributions to Godot are not research papers, so I adapted the general framework and made it more relevant for us.