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

Review the labelling system we use across our repos #4455

Open
6 tasks
kellylee-gds opened this issue Jan 20, 2025 · 3 comments
Open
6 tasks

Review the labelling system we use across our repos #4455

kellylee-gds opened this issue Jan 20, 2025 · 3 comments
Assignees

Comments

@kellylee-gds
Copy link
Contributor

kellylee-gds commented Jan 20, 2025

What

We currently have 137 labels in use across our repositories. However we are aware of some known issues with this labelling system which can be resolved by reviewing the system.

Why

Known issues:

  • we're not applying labels consistently when creating issues
  • the large number of labels makes it difficult to search for the ones you need
  • pertinent labels are often presented from the perspective of a user (ie: if I'm updating documentation, I want to use the documentation label, but it's described as "user asks for documentation", so it's unclear if I should).
  • they are applied inconsistently across our repositories (eg a label is created in govuk-design-system but not design-system-team-internal or govuk-frontend)
  • there is no oversight or process to follow when creating labels, and they are used for personal issue management rather than team
  • the labels repo is not used when adding labels resulting in the source code consistently being out of date
  • not all labels have descriptions which makes it difficult to identify the labels purpose
  • we're not using the currently labelling system for data analysis as originally intended

Who needs to work on this

Kelly, Romaric

Who needs to review this

The team

Done when

  • explored what potential uses there are for labels
  • identified which uses cases are possible and practical from a capacity and skillset perspective
  • agreed on a proposal to be reviewed by the team
  • feedback collected from the team and analysed
  • documented our decision making rationale and addressed each pain point
  • updated labelling system
@domoscargin
Copy link
Contributor

An issue I've found (other than not being able to find the right labels) is that pertinent labels are often presented from the perspective of a user (ie: if I'm updating documentation, I want to use the documentation label, but it's described as "user asks for documentation", so it's unclear if I should).

@kellylee-gds
Copy link
Contributor Author

Thanks @domoscargin — I'll add that to the list!

@querkmachine
Copy link
Member

For what it's worth, I find the labels to mostly be quite helpful, especially when it comes to searching the backlog of issues, such as if I'm looking for work to pick up, or trying to see if an issue with a component or pattern has previously been reported. Having the labels all be the same across repos makes doing that a lot easier.

GitHub has also recently (or is in the process of?) rolling out a UI change that makes label descriptions more prominent than they used to be, so hopefully their usage gets a bit more consistent or intentioned because of that.

An issue I do have is with the current names of some labels being quite vague. We have a colour-coding system to differentiate between styles, components and patterns, but other than that we have some fairly similar label names ("date input" the component vs. "dates" the pattern, "password input" vs. "passwords", the five different accessibility labels, etc.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Backlog 🏃🏼‍♀️
Development

No branches or pull requests

4 participants