Skip to content

Suggest renaming release note / migration guide labels#2293

Merged
alice-i-cecile merged 2 commits into
bevyengine:mainfrom
alice-i-cecile:must-needs
Oct 20, 2025
Merged

Suggest renaming release note / migration guide labels#2293
alice-i-cecile merged 2 commits into
bevyengine:mainfrom
alice-i-cecile:must-needs

Conversation

@alice-i-cecile

@alice-i-cecile alice-i-cecile commented Oct 20, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

Problem

M-Needs-Release-Note and M-Needs-Migration-Guide commonly confuse new contributors. If it needs a release note, and then the OP adds a release note, shouldn't we remove the label?

That's not how it works though! Keeping the labels around is helpful to allow for quick searches for impactful or breaking changes.

Solution

Just use M-Migration-Guide and M-Release-Note. Short, precise, adequately clear.

Alternative naming scheme: Spotlight and Breaking

Rename this to M-Spotlight and M-Breaking. These names are less directly tied to release notes and migration guides, but we have both long label descriptions and a helpful bot to clarify exactly what it means.

The shorter names are easier to talk about and take up less real estate when skimming PRs.

These were the best short names I could come up with, but I'm open to other suggestions.

Alternate naming scheme: Worthy

I also considered a longer, more explicit naming scheme. M-Release-Note-Worthy and M-Migration-Guide-Worthy were the best names in this category that I found. This eliminates the confusion around "needs", but is even more of a mouthful.

Follow-up work

Once this is approved and merged, I'll change the bevy repo labels accordingly.

@alice-i-cecile alice-i-cecile added A-Meta S-Needs-Review A-Contributing-Guide X-Contentious There are nontrivial implications that should be thought through labels Oct 20, 2025
@Atlas16A

Atlas16A commented Oct 20, 2025 •
edited
Loading

Copy link
Copy Markdown

I like the suggested M-Spotlight and M-Breaking however, I feel they are not exclusive to the original names.

The problem you describe is the contributor added a migration guide but the tag remains, I think the M-Needs-Release-Notes and M-Needs-Migration-Guide should remain for the purpose of signaling a lack of those items, but also adding the two suggested names to supplement them to fulfill the secondary purpose that the current tags are forced to fill.

@alice-i-cecile

alice-i-cecile commented Oct 20, 2025 •
edited
Loading

Copy link
Copy Markdown
Member Author

The problem you describe is the contributor added a migration guide but the tag remains, I think the M-Needs-Release-Notes and M-Needs-Migration-Guide should remain for the purpose of signaling a lack of those items, but also adding the two suggested names to supplement them to fulfill the secondary purpose that the current tags are forced to fill.

I think that S-Waiting-on-Author is plenty :) The bot will tell you when the label is added if you need to fix something.

@afonsolage

afonsolage commented Oct 20, 2025

Copy link
Copy Markdown
Contributor

I understand the confusion on the Needs part, but IMO M-Release-Note and M-Migration-Guide is enough to communicate the PR needs those.

@IQuick143

IQuick143 commented Oct 20, 2025

Copy link
Copy Markdown
Contributor

M-Migration-Guide-Worthy doesn't seem any more intuitive than M-Needs-Migration-Guide.

In fact if it "needs" a migration guide, then it's obvious that someone should add it (probably me as the PR author). Being "Worthy" of a migration guide sounds like I've won an award and someone is gonna hand a migration guide to me (or they aren't, I don't mind).

M-Breaking feels a little too short and less descriptive, M-Breaking-Change probably could work (combined with the bot message that checks for the presence of a migration guide. Similarly M-Migration-Guide might be sufficient.

@Shatur

Shatur commented Oct 20, 2025

Copy link
Copy Markdown
Contributor

I like the shortness of M-Spotlight and M-Breaking, but they aren’t very self-explanatory to me 🤔
That’s why I prefer the Worthy scheme a bit more.
However, the suggested M-Release-Note and M-Migration-Guide above are my favorites 🙂

@BD103

BD103 commented Oct 20, 2025

Copy link
Copy Markdown
Member

I have no strong preference on the naming, but note that the following files will need to be updated if the labels are renamed:

A simple grep should be able to take care of it, though! :)

alice-i-cecile
alice-i-cecile commented Oct 20, 2025
View reviewed changes
Comment thread content/learn/contribute/reference/triage.md Outdated
alice-i-cecile
alice-i-cecile commented Oct 20, 2025
View reviewed changes
Comment thread content/learn/contribute/reference/triage.md Outdated
@alice-i-cecile

alice-i-cecile commented Oct 20, 2025

Copy link
Copy Markdown
Member Author

@afonsolage @Shatur et al; I've changed the names. Can I get some approvals so I can move on to the next phase of this?

@Jondolf Jondolf mentioned this pull request Oct 20, 2025
Merged
Jondolf
Jondolf approved these changes Oct 20, 2025
View reviewed changes

@Jondolf Jondolf left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I like M-Release-Note and M-Migration-Guide, already made an Avian PR to match 😉 avianphysics/avian#870

@alice-i-cecile alice-i-cecile added this pull request to the merge queue Oct 20, 2025
@Jondolf Jondolf added S-Ready-For-Final-Review Ready for a maintainer to consider for merging and removed S-Needs-Review labels Oct 20, 2025
@alice-i-cecile alice-i-cecile mentioned this pull request Oct 20, 2025
Merged
Merged via the queue into bevyengine:main with commit 631879e Oct 20, 2025
10 checks passed
@alice-i-cecile alice-i-cecile deleted the must-needs branch October 20, 2025 17:18
Jondolf added a commit to avianphysics/avian that referenced this pull request Oct 20, 2025
@Jondolf
Rename C-Breaking-Change to M-Migration-Guide (#870)
d32c1d9 
# Objective

Bevy is (most likely) going to use M-Migration-Guide, see bevyengine/bevy-website#2293. For familiarity, we should update to match!

## Solution

Rename the C-Breaking-Change label to M-Migration-Guide in the migration guide process README. I'll need to update it on GitHub's side separately, assuming we merge this.
github-merge-queue Bot pushed a commit to bevyengine/bevy that referenced this pull request Oct 20, 2025
@alice-i-cecile
Rename M-Needs- labels (#21614)
8e10cbf 
# Objective

bevyengine/bevy-website#2293 proposed a rename
of our `M-Needs-Release-Note` and `M-Needs-Migration-Guide` labels for
improved clarity.

This has been approved, so I'm merging that PR.

This repo lists these labels in a few places for automation /
contributor help, and they need to be updated.

## Solution

Grep for these like @BD103 told me to in
bevyengine/bevy-website#2293 (comment)

## Follow-up work

Once this PR is merged I'll actually rename the label.
mate-h pushed a commit to mate-h/bevy that referenced this pull request Oct 22, 2025
@alice-i-cecile @mate-h
Rename M-Needs- labels (bevyengine#21614)
a7a9ffa 
# Objective

bevyengine/bevy-website#2293 proposed a rename
of our `M-Needs-Release-Note` and `M-Needs-Migration-Guide` labels for
improved clarity.

This has been approved, so I'm merging that PR.

This repo lists these labels in a few places for automation /
contributor help, and they need to be updated.

## Solution

Grep for these like @BD103 told me to in
bevyengine/bevy-website#2293 (comment)

## Follow-up work

Once this PR is merged I'll actually rename the label.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@Shatur Shatur Shatur approved these changes

@Jondolf Jondolf Jondolf approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

A-Contributing-Guide A-Meta S-Ready-For-Final-Review Ready for a maintainer to consider for merging X-Contentious There are nontrivial implications that should be thought through

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@alice-i-cecile @Atlas16A @afonsolage @IQuick143 @Shatur @BD103 @Jondolf