Improve pull request description template #503
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,27 @@ | ||
| <!-- Thank you for submitting a pull request! Find more information | ||
| at https://trino.io/development/process.html, | ||
| at https://trinodb.github.io/trino-gateway/development/#contributing | ||
| and contact us on #trino-gateway-dev in Slack. --> | ||
| <!-- Provide an overview for maintainers and reviewers. --> | ||
| ## Description | ||
|
|
||
|
|
||
|
|
||
| <!-- Provide details that help an engineer who is unfamiliar with this part of the code. --> | ||
| ## Additional context and related issues | ||
|
|
||
|
|
||
|
|
||
| <!-- Mark the appropriate option with an (x). Propose a release note if you can. | ||
| More info at https://trino.io/development/process#release-note --> | ||
| ## Release notes | ||
|
|
||
| - ( ) This is not user-visible or is docs only, and no release notes are | ||
| required. | ||
|
Comment on lines
+19
to
+20
|
||
| - ( ) Release notes are required. Please propose a release note for me. | ||
| - ( ) Release notes are required, with the following suggested text: | ||
|
|
||
| ```markdown | ||
| ## Section | ||
|
There was a problem hiding this comment. I don't think "Section" is helpful in this project. |
||
| * Fix some things. ({issue}`issuenumber`) | ||
|
There was a problem hiding this comment. This format doesn't work well in this project. The existing release note format is |
||
| ``` | ||
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.
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.
It's hard to copy these link. Ideally, it shouldn't have a leading
ator a following,.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 was talking to @wendigo in trino PR .. maybe we change these all to markdown outside the comment and at the end of the template.. then the links render properly. Wdyt @ebyhr
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 can send a follow up PR here or in Trino repo