Clean up and consolidate issue/PR labels (and update labeler workflow)
Description
The PEcAn repo has many GitHub labels (see the labels page), including duplicates, rarely used, and obsolete labels. We also have an automated PR labeler workflow in .github/labeler.yml. This issue aims to simplify and document the repository labels.
Goals
- Reduce the labels to a smaller, clearer, documented set.
- Avoid duplicates / near-duplicates and obsolete labels.
- Keep labeler.yml in sync with the final label set.
Tasks
-
[x] Inventory current labels
- Make a list of existing labels in a google doc or spreadsheet so the team can help with this.
- ~Provide a~ link to spreadsheet here:
- Identify:
- Duplicates and synonyms
- Obsolete labels - those with few or zero associated issues/PRs and / or otherwise not particularly helpful
- New Label
-
[ ] Audit and Propose updates - request input from maintainers / community
- Do we want to standardize around
category: labelformat? if so, categorize labels. - Color scheme
- Labels to combine (identify replacement)
- Labels to remove
- Color scheme
- Short description for each label
- Do we want to standardize around
-
[ ] Merge and delete labels; update colors
gh [pr|issue] edit --[add|remove]-label-namemay be useful here.
-
[ ] Review and
.github/labeler.ymlto- Use the new label names.
- Remove rules for deleted labels.
- add new rules if useful. Should we also automate labeling issues?
-
[ ] Document the label scheme
- Add descriptions to each label (these show up on labels page)
- Maybe? a short section to docs about rationale for scheme and how to use labels.
Hi @dlebauer! I'd like to work on this issue. I'm new to the PEcAn project and this seems like a great way to get started.
I plan to:
- Start by auditing the current labels and creating a spreadsheet
- Share the audit document for team feedback
- Work through the proposed updates collaboratively
Would you be able to assign this to me? I'm also happy to discuss any specific preferences you have for the label organization approach.
Hi @dlebauer, I’ve shared the document over Slack and am currently working on filling out the #issues and #prs columns in the spreadsheet
Thanks @Eshaan-byte - @shivpratikhande already got started with the work, but please feel free to contribute.