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

chore: add more labels to issues #4444

Closed
Yokozuna59 opened this issue Jun 1, 2023 · 6 comments
Closed

chore: add more labels to issues #4444

Yokozuna59 opened this issue Jun 1, 2023 · 6 comments

Comments

@Yokozuna59
Copy link
Member

Currently, it's hard to search for issues based on their labels. And from #4227:
 

The second is: please make sure you do a good search through the issues here before creating a new one!

So we might have duplicate issues since users could find what they were looking for.

So by adding more labels, users and developers would be able to filter issues and contribute to stuff they're interested in or related to each other.
 
You could add more labels for better visibility. For example:
 

Note: most issues have general labels, e.g., Status: Triage, that came from the GitHub issue templates. it doesn't help much for searching for issues which means duplicate issues.

@github-actions github-actions bot added the Status: Triage Needs to be verified, categorized, etc label Jun 1, 2023
@sidharthv96
Copy link
Member

I think triage was a label for maintainers to filter issues that needed to be categorized.

Status: Triage -> Needs to be verified, categorized, etc

@sidharthv96 sidharthv96 removed the Status: Triage Needs to be verified, categorized, etc label Jun 2, 2023
@sidharthv96
Copy link
Member

sidharthv96 commented Jun 2, 2023

Added 3 labels.

image

@aloisklink
Copy link
Member

I think triage was a label for maintainers to filter issues that needed to be categorized.

It would be nice to have a triaging guide too :)

I don't really have the time to look at every issue/PR, but when I do, I can't really triage since I don't know what many of the labels mean.

Just as an example, when do we use a feature or Type: Enhancement label? I swear that only Type: Enhancement PRs automatically go into the draft release notes (see https://github.com/mermaid-js/mermaid/blob/develop/.github/release-drafter.yml), but PRs are auto-labelled with feature if they come from a branch called feature/xxxxxx so 🤷

I'm sure there other people with triage permissions in the mermaid repo that don't triage since they don't know how to. And having a guide would make it easier to onboard new community members if they want to help with triaging.

@Yokozuna59
Copy link
Member Author

Looking at Type: Enhancement Description, it really state that it's a feature:

84665682-F137-448F-A6F6-0A2A08ECA55B

I upvote triaging guide! Or at least adding description to each label, adopting new ones, removing duplicates.

I'm more than happy to contribute if you're willing.


I would also suggest adopting the new github flow instead of the git flow.

As stated here from the author of git flow:

This is not the class of software that I had in mind when I wrote the blog post 10 years ago. If your team is doing continuous delivery of software, I would suggest to adopt a much simpler workflow (like GitHub flow) instead of trying to shoehorn git-flow into your team.

And by doing so it would be simpler and close to the current develop lifecycle to the contributors. Which results in cleaner labels, organized flow, less complexity, and much more!

@sidharthv96
Copy link
Member

Totally agree. I've also felt that we have too many labels and no guidelines on how to use them.

@knsv @ashishjain0512 @jgreywolf @mermaid-js/atlantians can anyone give us an idea of what the plans were for the labels?

@jgreywolf
Copy link
Contributor

I have been trying to clean up the labels here and there. Removing some, adding others, etc. I dont think there is an official plan in place, and we just need to come up with one.

As opposed to randomly making changes as I had been doing.

In general, I am a fan of like things being with like things. This means categorizing labels together (as we have no with some of them)

  • overall status
  • current workflow state
  • type: bug, request, chore...
  • component: parser, renderer...
  • diagram type

I think the that "topic" ones we have now should go away.

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

4 participants