Open ezio-melotti opened 2 years ago
We had another short discussion on Discord, here's the summary:
expert-*
)
C: *
or A: *
) are opaque
It seems to me that the best compromise is:
I think that quite a lot of people in discord agree that changing expert-
prefix to something like topic-
is benefitial.
Right now expert-
prefix might confuse new contributors by setting a difficulty level in their minds.
What do we need to do to change this? Formal vote?
This seems a reasonable suggestion to me.
What do we need to do to change this? Formal vote?
A discussion (possibly including a poll) on Discourse would be good both for reaching a consensus about the change (and new category name) and to advertise the change if/when it's accepted.
FWIW https://discuss.python.org/t/github-issues-migration-label-mapping/14212 has more context and previous discussions about labels and their grouping.
The vote was open for ~1 month, it is now closed. Results:
topic-
expert-
field-
CC @ezio-melotti
Draft PR to update the devguide once the labels are renamed: https://github.com/python/devguide/pull/1076.
Preview: https://cpython-devguide--1076.org.readthedocs.build/triage/labels/#topic-labels
I’ve renamed all the expert-*
labels to topic-*
.
These two PRs still need to be reviewed and merged:
If you set up projects automation (using the auto-add workflow from within the project), you might have to update the workflow to use the new label, since it doesn’t seem to update automatically. The auto-add workflow is somewhat new, so I don’t expect many projects to use it.
There are two ways to group labels on GitHub: by color and by using a common prefix. Even though the color-coding helps, without a common prefix, labels that belong in the same category are not grouped together in the "Labels" dropdown in the sidebar. On the other hand, adding a prefix to all labels makes them longer and adds clutter.
On
python/cpython
, we currently have 61 labels, that include misc labels (likeeasy
,pending
, etc.) and a few main groups, including:type-*
prefix)expert-*
prefix)OS-*
prefix)The "dir" category currently has 5 labels:
stdlib
,docs
,tests
,interpreter-core
, andextension-modules
, and they indicate what part of the source tree is affected, however since they have no prefix, they are not grouped. I'm not sure ifdir-*
would be a good prefix, but I can't think of anything better.Another idea suggested on Discord is to use emojis as prefixes for some categories, since they only take 1 character, are easily recognizable, and can convey some semantic meaning as well.
Some suggestions:
type-*
prefix:crash
andsecurity
, :blue_book: forbugs
, and :green_book: forfeature requests
OS-*
prefix: :computer: or :desktop_computer:invalid
/spam
release blocker
/deferred blocker
The main goals I want to accomplish are:
In addition I wanted to remove/rewrite the (already outdated) "GitHub Labels" page in the devguide and just document the categories, linking to the labels list on GitHub for the actual page and their description.
cc @Mariatta