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.

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

Improve pull request description template #503

Merged
merged 1 commit into from
Oct 2, 2024

Conversation

oneonestar
Copy link
Member

@oneonestar oneonestar commented Oct 2, 2024

Description

Copy from trinodb/trino#23636 with the following changes:

  • Remove the change on checkbox (Looks like the checkbox still being converted into a tasklist)
  • Update links
-at https://github.com/trinodb/trino/blob/master/.github/DEVELOPMENT.md 
-and contact us on #core-dev in Slack. -->
+at https://trinodb.github.io/trino-gateway/development/#contributing
+and contact us on #trino-gateway-dev in Slack. -->

Release notes

  • (x) This is not user-visible or is docs only, 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:
## Section
* Fix some things. ({issue}`issuenumber`)

@cla-bot cla-bot bot added the cla-signed label Oct 2, 2024
Copy link
Member

@mosabua mosabua left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@mosabua mosabua merged commit 110cd7c into trinodb:main Oct 2, 2024
3 checks passed
@github-actions github-actions bot added this to the 12 milestone Oct 2, 2024
Comment on lines +19 to +20
- ( ) This is not user-visible or is docs only, and no release notes are
required.
Copy link
Member

@ebyhr ebyhr Oct 2, 2024

Choose a reason for hiding this comment

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

Unwrap.

Copy link
Member

Choose a reason for hiding this comment

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


```markdown
*
## Section
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 think "Section" is helpful in this project.

Comment on lines +2 to +3
at https://trino.io/development/process.html,
at https://trinodb.github.io/trino-gateway/development/#contributing
Copy link
Member

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 at or a following ,.

Copy link
Member

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

Copy link
Member

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

@oneonestar oneonestar deleted the star/pr_template branch October 2, 2024 23:14

```markdown
*
## Section
* Fix some things. ({issue}`issuenumber`)
Copy link
Member

@ebyhr ebyhr Oct 3, 2024

Choose a reason for hiding this comment

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

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
Development

Successfully merging this pull request may close these issues.

3 participants