Cleaning up our GitHub issue labels

Since I volunteered to do the implementation, the format which would be most convenient for me would be a table with 3 columns:

Existing Label, New Label, New Description (if changed)

Notes:

  • If a label is to be deleted outright instead of migrated to a new label, just note that.
  • For completely new labels, just leave the "Existing Label" column blank.
  • The same "New Label" can be used for multiple "Existing Label" entries if the labels are to be merged.
  • If an existing label is going to be split, someone (not me) will need to retriage the issues, but I can at least create the new labels and descriptions.
    Let me know if you have any questions. If someone else wants to volunteer to do the implementation, they might have a different preferred format.

Tom

1 Like

Well, so far it's a list, not a tableā€¦ maybe we can use some open source data cleaning tool to turn the list into a table? :wink:

@Lydiaofficial if you want help with doing this conversion in OpenRefine, we can have a call to do that together :slight_smile:

Hi @tfmorris , I have attached a table that solves the issue raised in the Doc.

Maybe next time. I already put the labels into a table for Tom

@antonin_d - the table is in the end of the google doc, maybe this was unclear from @Lydiaofficial's first message. Based on my recommendation she created the table inside the same google doc, so comments can be made there more easily. After comments / adjustments, the data from the table can easily be pasted in the spreadsheet that @tfmorris started with existing labels.

Awesome! That's great. I took a quick pass through and left some comments, mostly focused on reducing redundancy with Github provided features and streamlining things for users of the labeling system.

As soon as comments die down and consensus is reached I can go through and implement the changes.

Tom

Hi @tfmorris & @antonin_d - I think the outstanding questions here seem to be more or less answered, or? Organizing Github Issues - Google Docs

In general, we can remove all duplicates (or labels that duplicate build-in functionalities in Github), but the rest can maybe already be implemented, so we can start using them in the documentation?

What do you think? Is there any benefit in waiting a bit longer, or shall we give the new structure a try and see if we hit any snags with it.

1 Like

Hi @tfmorris & @antonin_d - I think the outstanding questions here seem to be more or less answered, or? Organizing Github Issues - Google Docs

In general, we can remove all duplicates (or labels that duplicate build-in functionalities in Github), but the rest can maybe already be implemented, so we can start using them in the documentation?

What do you think? Is there any benefit in waiting a bit longer, or shall we give the new structure a try and see if we hit any snags with it.

Sounds good. I had a triathlon on Sunday, but I'll add this to my list for the next day or two.

Tom

@tfmorris do you still intend to implement the label changes on GitHub?
Happy to do it if you prefer. There is no rush, but I'd like to make sure that this outcome of the internship is not left by the wayside.

@tfmorris do you still intend to implement the label changes on GitHub?
Happy to do it if you prefer. There is no rush, but I'd like to make sure that this outcome of the internship is not left by the wayside.

Yes, but I'm blocked waiting for responses to my questions/comments from a month ago when I attempted the implementation.

See the Sept. 2 comments here: https://docs.google.com/document/d/19LLxQxQNgELxSuxT8nwgoWEHMdlGjjnJO20zFsZpLak/edit#heading=h.kg27uz10nl5i

Tom

p.s. I'm not sure how much longer the internship runs, but I'm happy
to prioritize this to assure a successful outcome.

From an implementation point of view, the easiest format to work from
is a table of:

old label, new label, new description

which I can just cut and paste directly from, with the old label being
optional if there's no previous equivalent.

Tom

1 Like

Ok! The internship has formally ended already, but @Lydiaofficial is sticking around a bit more helping out on the design for the reconciliation project, so she'll be reachable for a little while more at least.

@tfmorris , the descriptions in the GitHub label table have been rewritten to fit into the word count allowed in label descriptions.

the descriptions in the GitHub label table have been rewritten to fit into the word count allowed in label descriptions.

Thanks! I'll work on updating them over the weekend.

Tom

the descriptions in the GitHub label table have been rewritten to fit into the word count allowed in label descriptions.

Thanks! I'll work on updating them over the weekend.

The updates were applied the second week of October. Unfortunately, I missed the fact that some of them were used in our issue templates, so any issues created in the past few weeks will be missing the standard labels:

  • Type: Bug (was "bug")
  • Type: Feature (was "enhancement")
  • Status: Pending Review (was "to be reviewed")
    I fixed this yesterday and the templates should be working correctly again. Let me know if you see any other issues with the label updates.

As an aside, if you have automation scripts or saved URLs using the old labels, they will need to be updated as well.

Tom

1 Like