question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[INFRA] Review and update GitHub Labels

See original GitHub issue

We previously worked on that topic through #9

Status The default GitHub labels (enhancement, bug, …) have been renamed and now start upper case. This causes the following issues

  • issue templates label setting does not work any more as they reference lowercase labels (they could be updated). So this requires manual settings afterwards. Also remember that only collaborators can set labels on issues and PR, so issue created by outsiders will require label changes
  • this is uncommon in GitHub repositories to use such customized labels. This is something which is implicitly standardized: developers are used to these label names, they know their meaning at first glance
  • not having strict label name policy will mess tooling based on issue/PR labels (for instance release-drafter)

Proposal

  • all labels (usual and custom) should have a description to clarify their meaning and when they can be used (PR only for instance like Rebase Needed)
  • usual GitHub labels: keep the original lowercase names, avoid usage icons.
  • custom labels: use icons if it helps

Questions

  • do we need a security label for dependencies upgrade due to CVE
  • labels related to questions: question is a usual label for issue categorization. We introduced question asked and question answered for PR follow-up
    • do we keep them?
    • if so, how do we clearly distinguish them from the usual label

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:2
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

2reactions
tbouffardcommented, May 12, 2020

Changes on 2020-05-12

all labels now

  • start with lower case except when using acronym (BPMN, WIP)
  • have a description

pseudo-standard GitHub labels

  • icons removal
    • help wanted
    • invalid
  • rename
    • won't fix into wontfix

changes

  • rebase needed:
    • icon from 😱 to 💥 (collision, as mergeability produces collision on master)
    • color from #d93f0b to #ffa500

additions

  • cla not signed: prepare #187

removals

  • Question answered
  • Feedbacks integrated: label can only be set by repo collaborator so it couldn’t be used by external contributors which limits a lot it uses, alternatives exist (add comment to ping collaborator/assignee, …)

Review needed @aibcmars and @csouchet can you have a look at the changes I did If ok, please just put a 👍 reaction and/or close the issue

ℹ️ next time we want to change or review GitHub labels, we could setup an GH workflow to manage labels in a declarative way, using for instance

1reaction
aibcmarscommented, Apr 15, 2020

to respond to your questions:

  1. security label can be cool to have - for priority
  2. I personally do not need these: ‘question asked/answered’. I am more sticked to the native ‘Add comment’ ‘Resolve conversation’ github flow
Read more comments on GitHub >

github_iconTop Results From Across the Web

Kubernetes GitHub Labels - test-infra
Labels that apply to all repos, for both issues and PRs ; api-review, Categorizes an issue or PR as actively needing an API...
Read more >
Labels · kubernetes/test-infra - GitHub
187 labels ... Categorizes an issue or PR as actively needing an API review. ... Indicates a PR has been approved by an...
Read more >
Labels · openstack-infra/git-review · GitHub
This repository has been archived by the owner. It is now read-only. openstack-infra / git-review Public archive. Notifications · Fork 85.
Read more >
Labels - go-gitea/infrastructure - GitHub
Update. To update the list of labels you have to get into the folder of the specific cloned repository, than you can simply...
Read more >
Managing labels - GitHub Docs
You can manage your work on GitHub by creating labels to categorize issues, pull requests, and discussions. You can apply labels in the...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found