Improve pull request description template #503
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
oneonestar
force-pushed
the
star/pr_template
branch
from
0812a5e
to
eb08a84
Compare
ebyhr
reviewed
Oct 2, 2024
Comment on lines
+19
to
+20
| - ( ) This is not user-visible or is docs only, and no release notes are | ||
| required. |
ebyhr
reviewed
Oct 2, 2024
|
|
||
| ```markdown | ||
| * | ||
| ## Section |
There was a problem hiding this comment.
I don't think "Section" is helpful in this project.
ebyhr
reviewed
Oct 2, 2024
Comment on lines
+2
to
+3
| at https://trino.io/development/process.html, | ||
| at https://trinodb.github.io/trino-gateway/development/#contributing |
There was a problem hiding this comment.
It's hard to copy these link. Ideally, it shouldn't have a leading at or a following ,.
There was a problem hiding this comment.
I can send a follow up PR here or in Trino repo
ebyhr
reviewed
Oct 3, 2024
|
|
||
| ```markdown | ||
| * | ||
| ## Section | ||
| * 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
* xxx. ([#prnumber](https://github.com/trinodb/trino-gateway/pull/prnumber))
or
* xxx. ([#issuenumber](https://github.com/trinodb/trino-gateway/issue/issuenumber))
https://raw.githubusercontent.com/trinodb/trino-gateway/refs/heads/main/docs/release-notes.md
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
Copy from trinodb/trino#23636 with the following changes:
Release notes