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

Documentation around highlighting PRs for release notes. #19390

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

jmchilton
Copy link
Member

Introduces a new Github tag that lets contributors indicate they endorse including a PR in the user release notes and will do the work. This can be assigned by the PR author, reviewer, or any contributor willing to do the work to highlight the PR. The person assembling the user facing release notes will still have final say about what is included but this is a way of indicating to that person a strong preference for including a PR and willingness to help them do the work.

How to test the changes?

Does not apply.

License

  • I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

@jdavcs
Copy link
Member

jdavcs commented Jan 9, 2025

If we formalize these, then, I think, we should also mention highlight/admin and highlight/dev in a similar manner. Both are intended as suggestions to include a PR in the full release notes (usually bullet point lists of significant admin- and dev-related updates).

Also, highlight/user will effectively replace the highlight/power-user label, right? (and that would be an improvement, I think)

@@ -217,6 +217,20 @@ special purpose.
bug affects the actual current Galaxy development branch and isn't a usage
issue, a previously fixed issue, etc..

- ``highlight`` is a tag that indicates at least one contributor thinks this
pull request should be highlighted in some way in the relevant release's
release notes. The person assembling release notes has final say about
Copy link
Member

Choose a reason for hiding this comment

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

I wonder, do we need to include this last sentence? I think it's clear that the final contents of the release notes is determined by the release team (the release manager, or a team, a committee, etc. - whatever it is), and not by the person who added the label. To me, the text seems to be a little too specific and prescriptive: we'd have to edit this page every time we change our approach. Same goes for the user label below.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants