The GitHub Label Cleanup Proposal

[Hundrec]

Overview

The labeling system in this repository has become more and more useful since 0.3.0 was released.
For example, the status and type labels are now automatically applied upon issue creation.
However, a few inconsistencies have arisen in the past few months as new labels and GitHub actions have been implemented.

In this issue, I will detail actions that can be taken to organize and standardize labels to improve your workflow (especially with over 600 open issues!)

Important

Some of these changes will require edits to files such as label-actions.yml. I have created two associated PRs: #3918 and #3919.

Delete or Replace

Some labels duplicate the function of existing labels, or should be replaced with a better label.

Label	Applied Issues	Action
Bug	#3890	Unlabel and Delete
Fixed Interally	#2662 and #3917	Unlabel and Delete
duplicate	4 closed issues	Unlabel and Delete
Needs R&D	#3829	Delete and Replace with status: needs r&d

Categorize

The full list of labels is currently alphabetically disorganized. Sorting them into categories can clean this list up.

Category	Label	New Name	PR
Size	small	size: small	#3918
Size	medium	size: medium	#3918
Size	large	size: large	#3918
Topic	help wanted	topic: help wanted
Topic	mods	topic: mods
Topic	platform specific	topic: platform specific
Topic	polish	topic: polish
Topic	scoring	topic: scoring
Topic	chart editor	topic: chart editor

Color

Currently, Label Actions closes issues as not planned or complete for three status labels.

Just like the label status: rejected, highlighting these auto-close labels with prominent colors will serve two functions:

• Allow devs to easily spot and apply labels that close the issue in the desired manner.
• Allow community members to easily spot labels that indicate resolution.

Note

I can't obtain the exact Hex codes for existing label colors, so I will describe them in the table.

Label	Current Color	New Color	Purpose
status: needs r&d	Orange	Blue (status color)	Group with status
status: resolved internally	Teal	Blue (status color)	Group with status
status: resolved	Blue (status color)	Teal	Indicate auto-close
status: duplicate	Blue (status color)	Red (rejected color)	Indicate auto-close
low priority	White	Different shade of White	White should be reserved for automatically applied labels

Tip

Refer to the table below to see which labels close issues when applied.

Label	Close Reason
status: resolved	Completed
status: rejected	Not planned
status: duplicate	Not planned

Descriptions

Some labels do not currently have descriptions. Assuming that all changes before this section have been implemented, there are two labels that should be described.

Label	Proposed Description
potential duplicate	Issue or PR may be redundant to another.
status: resolved internally	Completed development and will be released some time in the future.

Closing

Important

These changes should be replicated in the funkin.assets repo as well.

I believe that organization is essential for an improved workflow on GitHub.
Thank you for your time and consideration!

[AbnormalPoof]

This seems great for the most part, but I do feel like some labels (status: needs r&d, topic: help wanted, low priority) could be part of a miscellaneous category of some sorts (something like tag: or misc: ?).

[Hundrec]

Good idea! I also felt like rounding up those labels would complete the alphabetization, but wasn't sure what to call the new category.