-
Notifications
You must be signed in to change notification settings - Fork 3.1k
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update pull request template #13947
Update pull request template #13947
Conversation
eaa4663
to
0566c91
Compare
.github/pull_request_template.md
Outdated
<!--Provide a user-friendly explanation, keep it brief if it isn't user-visible.--> | ||
## Non-technical explanation |
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.
Can you share an example of what you think you would like to see here? I can't see the utility of this over the description above.
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 think for a lot of things, this is going to simply be "Refactor" or "Update tests" or "Upgrade dependency version" or something along those lines, or otherwise a simple restatement of a description which is easily understood from a non-technical perspective.
As an arbitrary example where it would be helpful, on #13736, it would be useful to say something like "make sure Trino stops running if it can't secure sufficient resources" in this section, because a less-technical user won't understand what jvmkill is or why terminating the jvm matters.
The section admittedly won't provide a ton of value most of the time, but when it does, it'll help a lot with making sure release notes make sense in situations where the PR author wouldn't otherwise provide a ton of detail as to why users should care about a change.
0566c91
to
bfbab99
Compare
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.
Definitely a step in the right direction.
( ) No release notes entries required. | ||
( ) Release notes entries required with the following suggested text: | ||
( ) This is not user-visible and no release notes are required. | ||
( ) Release notes are required, please propose a release note for me. |
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.
is it intentionally not using checkboxes (* [ ]
)?
checkboxes would allow the option to be marked with a click.
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 think @mosabua told me at one point that that something in Trino's Github automation expects all of them to be ticked before a PR is merged? I've kind of just gone off of that, and I assumed it was previously made to be parentheses for a reason.
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.
Correct.. if you use [] it counts as a build action..
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.
bfbab99
to
639d99b
Compare
@colebow can you please address #13947 (comment) in a followup? |
btw many thanks for simplifying this! |
Description
If we're changing the template to this, we also need to be sure that it is being filled out by everyone, always. There are three touchpoints, the first one is the most important as the broad description that helps with a review, and the other two can be very brief, especially for technical changes that aren't user-facing and shouldn't require much effort. "Just tests" or "refactor" and a single (x) will handle test changes/refactors for those last two questions, and it'd be nice to see that done for every PR with no exceptions. This change shortens it from 1-2 minutes of scrolling and trying to find the right places to type to an extremely quick and trivial process, and it should be low-friction enough for it to be used by everyone.
Alternate approach to #13916.
I would also want to accompany this change by adding #13916 (comment) to the Trino project.
Non-technical explanation
Updating the PR template on GitHub! I'm even using the new template here.
Release notes
(x) This is not user-visible and no release notes are required.
( ) Release notes are required, please propose a release note for me.
( ) Release notes are required, with the following suggested text: