search

isaacs / github

Just a place to track issues and feature requests that I have for github
2.21k stars 129 forks source link

[meta] clean up and document labels in this issue tracker #1549

Open aspiers opened 5 years ago

aspiers commented 5 years ago

As mentioned by @TPS in #1472, this issue tracker has almost 100 labels without any clear strategy or documentation for how to use them.

We should add a policy document (e.g. labels.md) to the repo which addresses this, and then anyone can submit PRs suggesting changes.

TPS commented 5 years ago

There are some names I’ve used like render which are internal to GitHub and need explanation to have meaning. I want the labels to be obvious and useful internally and externally.

@clarkbw Did you want to handle the internal/external consistency yourself (b/c AFAIK you're the only GitHub staff who's also a collaborator here)? Else, if you gave some guidelines/docs, I'd happily help w/ that.

TPS commented 5 years ago

To perhaps start this, I'd like to meekly quote myself:

my rule-of-thumb is try to use label combinations that best express what the issue's about

somewhat independent of what else might be labeled such. Most of the time, related issues do end up grouped, but, sometimes, issues only conceptually similar do end up w/ the same label. https://github.com/isaacs/github/issues/1547#issuecomment-487704640 makes a great example of this.

I think in a typical repo, this would be acceptable, & projects would be used to group more tightly-related issues, milestones grouping projects, &c. Here, how do we want to do it?

clarkbw commented 5 years ago

I've made some progress so far on a first pass, will keep updating this as I go.

label description
accessibility A11y related issues with GitHub interfaces
API Requests related to the GitHub developer API
archive Archived or archiving repository interactions
authentication SMS, 2FA, MFA, WebAuthn, passwords, and other related authentication schemes
automation Reducing manual interactions and increasing productivity through automated processes
bug 🐛
pull-requests Anything to do with PRs https://github.com/isaacs/github/pulls
TPS commented 5 years ago

Does anyone mind if I emojify a few more labels, since @clarkbw has now set a (perhaps dangerous 😉) precedent w/ the update to the bug 🐛 label? Or should that be kept special?

clarkbw commented 5 years ago

Emoji away! :-D

On Fri, May 17, 2019 at 5:13 AM TPS notifications@github.com wrote:

Does anyone mind if I emojify a few more labels, since @clarkbw https://github.com/clarkbw has now set a (perhaps dangerous 😉) precedent w/ the update to the bug 🐛 label https://github.com/isaacs/github/labels/bug? Or should that be kept special?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/isaacs/github/issues/1549?email_source=notifications&email_token=AAAAQVRKL4KQ3X7A7QQWWS3PV2OOHA5CNFSM4HHWJ4YKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODVUSWSQ#issuecomment-493431626, or mute the thread https://github.com/notifications/unsubscribe-auth/AAAAQVS7BE2Y6WNBH3WFNXLPV2OOHANCNFSM4HHWJ4YA .

TPS commented 5 years ago

1 concern: existing manual links to these break whenever renaming labels (which includes adding emoji, naturally — it's why I edited a couple of our posts above). The UI links by GitHub rendering update fine, though. Is that important enough to keep from messing too much w/ these on a wholesale basis?

AFAIK, GitLab's ~<label> syntax solves this pretty neatly.

captn3m0 commented 5 years ago

-1 for Emojis in labels: https://github.com/isaacs/github/issues/1580

TPS commented 5 years ago

@cirosantilli Well, since I invited comment here, why's the separate issue needed? But you do make a good point. 🙇🏾‍♂️

cirosantilli commented 5 years ago

I removed the bug emoji now since people seem to agree https://github.com/isaacs/github/issues/1580

aspiers commented 5 years ago

Thanks everyone for your contributions here! Can I suggest that we move this list of labels into a new file in the repo (e.g. LABELS.md or something like that)? That way anyone can submit PRs making the list better, and also it makes it more visible to end users.

TPS commented 5 years ago

Dunno if this rates a separated Meta issue: Would GitHub Actions be helpful in automatically applying these? That Labeler template seems mighty inviting.… except it's for PRs.…

TPS commented 5 years ago

There's now the Issue Label Bot.… Whaddy'all think re: letting it loose here⁈

TPS commented 4 years ago

The equivalent GitHub Action as Labeler, but for issues, seems to be tag-ur-it. (FWIW, it's been further developed by a GitHub ex-staffer.)