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

Sort out repository labels #3849

Closed
tisonkun opened this issue May 1, 2024 · 5 comments · Fixed by #3951
Closed

Sort out repository labels #3849

tisonkun opened this issue May 1, 2024 · 5 comments · Fixed by #3951
Assignees
Labels
help wanted Extra attention is needed

Comments

@tisonkun
Copy link
Contributor

tisonkun commented May 1, 2024

What type of enhancement is this?

Other

What does the enhancement do?

We gradually define a lot of labels in this repository. To give developers an intuitive impression and avoid some common mistakes, I suppose we sort out the labels with a few best practices.

  1. Retain automation labels. For example, dependabot uses Dependency label, and we just leave it as is. The contribute page depends on good first issue label, and we should leave it as is.
  2. Avoid whitespace. For other labels, avoid whitespace, so that we can parse it more reliably.
  3. Drop Difficulty labels since it's often hard to say. We have good first issue to identify relative easy issue already; others are by default need some investigation.
  4. Drop Priority labels since we don't use them.

So, following the pattern from how CockroachDB defines labels, I suppose we have the following labels:

  • good first issue
  • help wanted
  • breaking-change
  • release-blocker
  • tracking-issue

Follow-ups: see #3855.

Origins:

  • O-fuzz (found by fuzz)
  • O-end-to-end (found by end-to-end tests)
  • O-chaos (found by chaos tests)

Area:

  • A-metasrv
  • A-storage
  • A-observability
  • A-compaction
  • A-distributed-write
  • A-distributed-query
  • A-write
  • A-query
  • A-flow
  • A-index
  • A-metric-engine
  • A-wal
  • A-region-autopilot
  • A-frontend

Category:

  • C-bug
  • C-user-experience
  • C-enhancement
  • C-feature
  • C-performance

Implementation challenges

No response

@tisonkun
Copy link
Contributor Author

tisonkun commented May 1, 2024

What do you think? cc @GreptimeTeam/db-approver

I'd correspondingly update the label, the automation, and issue templates.

@evenyag
Copy link
Contributor

evenyag commented May 2, 2024

Looks good.

@tisonkun tisonkun self-assigned this May 3, 2024
@tisonkun tisonkun added the help wanted Extra attention is needed label May 3, 2024
@tisonkun
Copy link
Contributor Author

tisonkun commented May 3, 2024

@evenyag Thanks for your review. For follow-ups label, I create #3855 for further discussion. The current solution is mixed, brittle and actually already has some edge cases.

@fengjiachun
Copy link
Collaborator

Looks great!

@tisonkun
Copy link
Contributor Author

Thanks for your feedback. I'll apply the changes before tomorrow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants