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

Sane github labels #1195

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 109 additions & 0 deletions .github/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,115 @@ repository:
allow_rebase_merge: true

labels:
# sane labeling scheme
- name: 'Priority: Critical'
color: "#e11d21"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please Stick to our Company wide prios from P1 to P4

board: false
priority: 10
- name: 'Priority: High'
color: "#eb6420"
board: false
priority: 9
- name: 'Priority: Medium'
color: "#fbca04"
board: false
priority: 8
- name: 'Priority: Low'
color: "#009800"
board: false
priority: 7
- name: 'Status: Abandoned'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is this different to having the ticket closed, maybe with a comment that it was abandoned?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A label makes this obvious when listing issues.

color: "#000000"
board: false
priority: 1
- name: 'Status: Accepted'
color: "#009800"
board: true
priority: 1
- name: 'Status: Proposal'
color: "#e11d21"
board: true
priority: 1
- name: 'Status: In Progress'
color: "#cccccc"
board: true
priority: 1
- name: 'Status: TBD'
color: "#e11d21"
board: false
priority: 1
- name: 'Status: Review Needed'
color: "#fbca04"
board: true
priority: 1
description: Needs review from a maintainer
- name: 'Status: Revision Needed'
color: "#e11d21"
board: false
priority: 1
description: Needs code input from a maintainer
- name: 'Status: Doc Needed'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a status that requires that one issue can have more status flags set. That I find confusing.

I think having a flag that indicates that Doc, Test, UI Test or Changlog is still needed is great, but that should not be a status.

color: "#006b75"
board: true
priority: 1
- name: 'Status: Available'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feels very generic to me.

color: "#bfe5bf"
board: true
priority: 1
- name: 'Status: Blocked'
color: "#e11d21"
board: false
priority: 1
description: Blocked because of upstream dependencies
- name: 'Status: Wontfix'
color: "#D2DAE1"
board: false
priority: 1
- name: 'Type: Bug'
color: "#e11d21"
board: false
priority: 11
- name: 'Type: Maintenance'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What exactly does this say in our case?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not on this "early stage" of the project (early as in we just shipped a technical preview and things won't drift too far from it) but as it develops and dependencies develop we will have maintenance tasks, be it manually update a dependency (without dependabot) or improve some areas

color: "#fbca04"
board: false
priority: 1
- name: 'Type: Enhancement'
color: "#84b6eb"
board: false
priority: 1
- name: 'Type: Discussion'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In general I like that. But now that GH has the new feature Discussions we should think of enabling them? That would, however, immediately raise the question how that is different from central ...

To make the review concrete here: I would remove this flag.

color: "#cc317c"
board: false
priority: 1
- name: "¯\\_[ツ]_/¯"
color: "#FFC107"
board: false
priority: 1
- name: "[ノಠ益ಠ]ノ彡┻━┻"
color: "#333333"
board: false
priority: 1
- name: 'Type: Security'
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we already have a security label, please consolidate

color: "#EE3F46"
board: false
priority: 11
- name: 'Type: Feature'
color: "#91ca55"
board: false
priority: 1
- name: 'Type: Optimization'
color: "#5EBEFF"
board: false
priority: 1
- name: 'Type: UI/UX'
color: "#FFC274"
board: false
priority: 1
- name: 'Type: Compatibility'
color: "#000000"
board: false
priority: 1
# !sane labeling scheme
- name: bug
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Further up, we have Type: Bug

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes. I only added all the default "sane" labels from the article. To prevent from existing labels from disappearing I'll leave the old ones until I finish grooming the issue tracker.

color: d73a4a
description: Something isn't working
Expand Down