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

Label suggestions #760

Open
mfisher87 opened this issue Jul 11, 2024 · 0 comments
Open

Label suggestions #760

mfisher87 opened this issue Jul 11, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@mfisher87
Copy link
Collaborator

mfisher87 commented Jul 11, 2024

I think we can make our labels a bit more clear by making them multi-part with a delimiter (: or /). Many other projects do this, e.g. matplotlib. I don't have other great examples off the top of my head. What other projects are absolutely rocking the labels?

To start with, I propose:

  • automation CI, CD, or other automation -> impact/automation
  • bug Something isn't working -> type/bug
  • dependencies Pull requests that update a dependency file -> impact/dependencies
  • documentation Improvements or additions to documentation -> impact/documentation
  • duplicate This issue or pull request already exists -> type/duplicate
  • enhancement New feature or request -> type/enhancement
  • feedback requested We requested feedback from the reporter; if we don't hear back in X days the issue may be closed -> needs/feedback
  • github_actions Pull requests that update GitHub Actions code -> remove, we have the impact/automation label for this
  • good first issue Good for newcomers -> keep as-is, this is a special label we want to optimize for searchability
  • hackathon An issue we'd like to visit during a hackathon event -> ?
  • help wanted Extra attention is needed -> needs/help
  • invalid This doesn't seem right -> remove? unused.
  • python Pull requests that update Python code -> remove? unused. or: impact/library. Or impact/core in preparation for a future impact/plugin label.
  • question A question needs to be answered to proceed -> remove? Should use GitHub discussions?
  • wontfix This will not be worked on -> type/will-not-do (using a contraction in a label without spacing is really hard to read even as a native English speaker - we can be more inclusive :) )

#281 offers us a mechanism to automatically apply these labels as issues are created. It also offers a mechanism to remove or avoid some labels by directing users away from Issues and towards a more appropriate place, e.g. type/feature-request need not exist as a "request" should (IMO :) ) start in Discussions and only become an issue once we agree it is a feature we will implement. Same for type/question.

I also propose colorizing the items based on the group they're in!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: 🆕 New
Development

No branches or pull requests

1 participant