Azure / azure-sdk-tools

Tools repository leveraged by the Azure SDK team.
MIT License
112 stars 172 forks source link

Add Type Prefix to Issue Labels #8627

Open ronniegeraghty opened 1 month ago

ronniegeraghty commented 1 month ago

Add prefixes to issues labels related to their type.

Examples:

  1. issue-addressed -> workflow: issue-addressed
  2. Mgmt -> Plane: Mgmt
  3. Service Bus -> Service: Service Bus

Concerns:

  1. Proper Syntax:

    • Should the type be added to the label as a prefix or suffix?
    • How should the type be separated from the actual label text? Dash or colon?
    • Some existing labels are all lower case with dashes and some have the first letter capitalized with spaces. Should the types have a unified styling or should they match the style of the labels in their type.
    1. Updating the existing labels:
      • We currently don't have an automated way for us to update labels. We can push new labels out, but they won't overwrite the old labels.
      • We cannot remove the old labels then add the new labels. We need to update the labels, so the issue tagged with the old labels get the updated version.
  2. Updating GitHub Action rules:

    • All GitHub Action rules need to be updated to use the new issue labels.
kurtzeborn commented 1 month ago

Assigning this to @JimSuplizio since he'll do this work, but it's important that @jsquire provide input and @ronniegeraghty should probably run this change past all the language leads as well.

jsquire commented 1 month ago

Well, this opens up the question: If we're going to go through all of this, can we PLEASE stop doing a 2-label system? The whole pink+yellow classification is difficult to work with and causes issues. I think everyone (especially @joshfree ) would love to see us adopt a consistent format with a single label.

For example, something like:

would be better than

and can we stop treating color as significant?

jsquire commented 1 month ago

Also, @ronniegeraghty - be aware that this overhaul will invalidate all the ML models for the AI service. If we just rename in place, I can retrain and we won't lose confidence. If we make the more wholistic change that I'm advocating for, we'll end up needing to do some scripting to fix up the old issues so that we can retrain.

ronniegeraghty commented 2 weeks ago

Attempting to bridge the problem by adding a prefix to the label description so people can search the description prefix.

JimSuplizio commented 2 weeks ago

I've assigned this to both @ronniegeraghty and myself because, if this ends up getting done, the work won't be just on my plate.