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.

Sign up for GitHub

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
+14 −0
Open

Documentation around highlighting PRs for release notes. #19390

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions doc/source/project/issues.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

which pull requests are actually highlighted.

- ``highlight/user`` is a tag that indicates assigner of the tag thinks this
pull request should be highlighted prominently in the relevant release's
user facing release notes. The assigner of this tag is giving a strong
endorsement of this highlight and is willing to do the work of writing
the blurb for the release notes. If selected, the blurb should be written
with target audience in mind - researchers using the Galaxy user interface.
The person assembling the user release notes has final say about which
pull requests are actually highlighted.

The Roadmap
===========

Expand Down
Loading