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

[Discussion] Current state of issue labels #3168

Open
MatthewSH opened this issue Oct 29, 2023 · 3 comments
Open

[Discussion] Current state of issue labels #3168

MatthewSH opened this issue Oct 29, 2023 · 3 comments
Milestone

Comments

@MatthewSH
Copy link
Contributor

MatthewSH commented Oct 29, 2023

This has been brought up before and it's something I know I personally have issues with. I know my coworker also expressed confusion about it too.

I just wanted to take a moment to go through some of the labels and label groups and share some thoughts.


Starting with [HELP WANTED] good first issue. I've beat this one into the ground but I'll put it officially on paper. It makes no sense, to me, to be one label. help wanted can apply to issues which may not be good first issue for users. For example, I'd probably leave non-priority good first issue issues to new contributors while wanting to seek out other issues in need of attention. Right now there's no way of doing this.

Before: [HELP WANTED] good first issue
My recommendation: help wanted, good first issue


Speed run through the rest of them, if I understand what they're for and my comments:

  • p-X: Plugins, I assume we'll still need this at some point.
  • pkg-X: Packages in the monorepo
  • t-X: Type? Why not just type-X? It's just one more letter that pkg-X, I think this would be an improvement and increase in clarity
  • template: makes sense, just is template changes
  • w-X: No clue, am I just blind? I know the purpose of the labels, but I have no clue what the w is.
  • i-X: There's only one label with this, i-duplicate, is this referring issue? Why not put w labels in here?
  • bulk-pr-meister: I see this was used once, is this label still needed? It seemed like a one-off
  • docs-commit-without-effect: I guess I just don't understand the naming. Why not make it like a "child" of api-docs-commits like api-docs-commits-no-impact or something. I guess there's no real issue but even after reading the description I had to still go to the issues it was assigned to so I could see what it means. That may just be a me thing though, so no biggie.

Documenting the labels I think is important as a contributor, especially when you're auto-labeling or have multiple types. Might be worth adding something to contributing like Black, PowerShell, NextJS (in a way). Could expand the contributing to the current page being intro and the rest as "further reading" as reference pages or just supplemental documentation on things such as this. I don't think DD needs as detailed documentation as some of these repos, but it would be nice to have like "cheat sheets."


If I think of anything else, I'll add comments.

@itohatweb
Copy link
Member

The issue labels are documented btw: https://github.com/discordeno/discordeno/labels?page=1&sort=name-asc

@itohatweb
Copy link
Member

About help wanted I agree. We should have 2 labels: help-wanted good-first-issue.

About the labels with prefixes, those are just meant to group them together in the List. Yes they do have a deeper meaning too, but that's not something anyone needs to know in order to contribute. Since labels are assigned by the members of the org, or automatically by a bot.

Labels which are not used anymore like bulk-pr-meister can be marked as deprecated.

docs-commit-without-effect can indeed be renamed to irrelevant-api-docs-commits

I don't really see the need for having a dedicated documentation about them, but if it's needed a link to https://github.com/discordeno/discordeno/labels?page=1&sort=name-asc can be added.

@MatthewSH
Copy link
Contributor Author

@itohatweb that's where I was looking. which is when going through the labels most made sense.
Could at least be worth pointing to the list in the documentation.

@H01001000 H01001000 added this to the v19 milestone Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants