Skip to content
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

github: unify PR description and commit message #36205

Merged
merged 1 commit into from
Aug 3, 2023
Merged

github: unify PR description and commit message #36205

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
22 changes: 15 additions & 7 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,25 @@ Please label this PR with one of the following labels, depending on the scope of
- Docs
-->

## What does this PR do?
## Proposed commit message

<!-- Mandatory
Explain here the changes you made on the PR. Please explain the WHAT: patterns used, algorithms implemented, design architecture, message processing, etc.
-->
Explain here the changes you made on the PR.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would remove this one as we already have "Please explain:" just after.
Otherwise everything is good to me!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this is a matter of style. The text here reflects the text that was previously there, just now on two lines. The thinking that I had with retaining the text as it is was that the first line is the overall goal of the section, while the second is the specific parts that should be addressed. If you still want me to remove it given that, I'm happy to.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have a problem with it as it is, but if you can make it shorter people are more likely to read it :p

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree about that. We need to have reviewers on board to point to this, so the main issue is whether that will happen.


## Why is it important?
Please explain:

<!-- Mandatory
Explain here the WHY, or the rationale/motivation for the changes.
- WHAT: patterns used, algorithms implemented, design architecture, message processing, etc.
- WHY: the rationale/motivation for the changes

This text will be pasted into the squash dialog when the change is committed and will be
a long term historical record of the change to help future contributors understand the
change, please help them by making it clear and comprehensive, they may be you.

If the commit title is adequate to describe both of these things, The text here may be omitted
or replaced with "See title". The title of the PR will be used as the commit message title when
the merge is made and the "See title" marker will be removed if present.

The text here and the PR title will be subject to the PR review process.
-->

## Checklist
Expand All @@ -34,7 +43,6 @@ List here all the items you have verified BEFORE sending this PR. Please DO NOT
- [ ] I have made corresponding change to the default configuration files
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have added an entry in `CHANGELOG.next.asciidoc` or `CHANGELOG-developer.next.asciidoc`.
- [ ] I have made my commit title and message explanatory about the purpose and the reason of the change

## Author's Checklist

Expand Down