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

Change labels structure #516

Merged
merged 13 commits into from
Apr 2, 2024
Merged

Change labels structure #516

merged 13 commits into from
Apr 2, 2024

Conversation

BANOnotIT
Copy link
Collaborator

@BANOnotIT BANOnotIT commented Mar 21, 2023

Notable changes:

  • bug -> T - Defect
  • docs -> P - Docs
  • help wanted -> good first issue
  • refactor -> T - Task
  • proposal -> P - Proposal
  • investigate -> need info

Labels to be deleted:

  • tests
  • types
  • question
  • invalid
  • design
  • examples

@stackblitz
Copy link

stackblitz bot commented Mar 21, 2023

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@vercel
Copy link

vercel bot commented Mar 21, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
reatom ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 2, 2024 0:16am

@BANOnotIT BANOnotIT marked this pull request as ready for review March 21, 2023 16:23
@BANOnotIT
Copy link
Collaborator Author

@artalar so how do we proceed with this? Do you need any more info or any feedback?

@BANOnotIT
Copy link
Collaborator Author

https://github.com/marketplace/actions/github-labeler might be a good idea to have this app installed

@artalar
Copy link
Owner

artalar commented Jul 24, 2023

@BANOnotIT I'm finally ready to dive into this :) Will you update any conflicts and other things if needed?

@BANOnotIT
Copy link
Collaborator Author

Uhm... I would consider this thing as wip since I found a solution that can manage tags automatically

@BANOnotIT
Copy link
Collaborator Author

Could you review the tag system first? I mean the structure and check it there are any problems I might missed

@artalar
Copy link
Owner

artalar commented Jul 24, 2023

@BANOnotIT my thoughts

  • bug - for unexpected hurt runtime behavior of a library, it should be obvious.
  • problem - for types issue, CI&CD problems, docs styles issues and so on. I think we should separate this kind of issues and bugs to prevent misunderstood about the quality of the product.
  • docs is fine.
  • good first issue is fine.
  • refactor / task - don't get it, isn't is proposal?
  • proposal is fine, but it could be task too.
  • need info is fine.

What about CI also?

@BANOnotIT
Copy link
Collaborator Author

BANOnotIT commented Aug 5, 2023

@artalar

  • I propose using general Type Defect instead of bug and problem because we can define what exactly is behaving abnormally using Parts: package, docs or types. That's the main idea behind deviding Type and Parts
  • refactor becomes T - Task. Tasks should be treated as a piece of work to be done: move files around, setup tests, change CI parts and other things.
  • T - Proposal should not be Task. Proposal should be a discussion issue that implementing Tasks could be lined to.
  • CI is Part.

Also in rust repo they use labels without spaces in format X-dead-beef with leading uppercased type letter and other part of the label kebab-cased to be easily handled by bots and people in filters. I guess that's a great UX thing. What do you think?

@artalar
Copy link
Owner

artalar commented Mar 26, 2024

@BANOnotIT Hi! I don't want to create many labels. My experience in a regular job shows me that for actual work, task and bug is sufficient.

However, as we are a public project, we should have a couple of additional labels.

The help wanted label is needed to indicate that the issue could be addressed by an external contributor.

The problem / defect (up to you) label is needed for bugs that are not relevant to user functionality, such as documentation, CI, types or so on. This distinction is important for our marketing perspective.

@BANOnotIT
Copy link
Collaborator Author

Well I think unless we do some automation dependent on labels we don't really need a Scheme.

Can you elaborate how bug and separate problem/defect affects marketing?

Also, I wanted to rename "help wanted" because "good first issue" had a separate view in GitHub and we can employ it.

@artalar
Copy link
Owner

artalar commented Mar 26, 2024

@BANOnotIT "Bug" is a common label that a new user investigates when trying to evaluate a library. If we have extra bugs for docs, CSS, CI, and so on, it will present the library in the wrong light, literally in the wrong way.

good first issue is ok, you are right.

@artalar
Copy link
Owner

artalar commented Mar 26, 2024

@BANOnotIT one more thing. All proposals and feature requests should starts from https://github.com/artalar/reatom/discussions

@artalar
Copy link
Owner

artalar commented Mar 30, 2024

@BANOnotIT ping

@BANOnotIT
Copy link
Collaborator Author

@artalar artalar merged commit 38f40c9 into v3 Apr 2, 2024
5 checks passed
@artalar artalar deleted the labels-organisation branch April 2, 2024 12:17
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

Successfully merging this pull request may close these issues.

2 participants