Use Description for commit message
#3082
Merged
Conversation
This file contains 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
jxs
approved these changes
Nov 4, 2022
elenaf9
reviewed
Nov 7, 2022
mxinden
approved these changes
Nov 13, 2022
This was referenced Nov 13, 2022
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Whilst using the new mergify configuration, I've found that I almost always want to have the PR description as the commit message body.
Additionally, this will incentivize us to edit the description to something nice before merging which helps future folks who find the PR via the changelog for example.
Quite often, I also find myself to wanting to make "notes" or remarks about the PR itself, for example, that patch-by-patch review is recommended or why I am requesting a review from certain people. Those would be unnecessary in the commit message so I am also introducing a
Notessection.Notes
Requesting a review from all maintainers primarily for visibility and because it is somewhat a change in process.
Links to any relevant issues
Open Questions
Change checklist