Skip to content

Improve label versions triaging #1613

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Improve label versions triaging #1613

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
10c2b84
improve label versions triaging
picnixz Jul 20, 2025
03c1d37
Update triage/labels.rst
picnixz Jul 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 38 additions & 1 deletion triage/labels.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ These labels are used to specify the type of issue:
core dump.
* :gh-label:`type-feature`: for feature requests or enhancements.
Feature requests do not need :ref:`version labels <Version labels>`;
it is implicit that features are added to the ``main`` branch only.
it is implicit that features are added to the ``main`` branch only,
except for some :ref:`exceptional cases <exceptional-version-labels>`.
The `Ideas Discourse category`_ can be used to discuss enhancements
before filing an issue.
* :gh-label:`type-security`: for security issues.
Expand Down Expand Up @@ -97,9 +98,45 @@ These labels are used to indicate which versions of Python are affected.
The available version labels (with the form :samp:`3.{N}`) are updated
whenever new feature releases are created or retired.

Triagers may adhere to the following recommendations:
Copy link
Member

@StanFromIreland StanFromIreland Aug 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Triagers may adhere to the following recommendations:
Recommendations on when to use the labels:

Copy link
Member Author

@picnixz picnixz Aug 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't want to make it more mandatory or recommend than it is. I feel that "Guidelines" is too strong for such recommendations in how I see it. Well.. there is maybe one exception when we add a version label to a feature but all other points are really optional

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I modified the suggestion to "recommendations"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To the point and linkable:

Suggested change
Triagers may adhere to the following recommendations:
Recommendations
---------------


- For security issues, add the :gh-label:`type-security` label and
the affected version labels. This makes the issue stand out.

- For non-security issues affecting *all* bugfix branches, only add
the :gh-label:`type-bug` label as knowing which versions are affected
does not give more information.

Once the bug is resolved, one can optionally add the version labels for
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

More direct:

Suggested change
Once the bug is resolved, one can optionally add the version labels for
Once the bug is resolved, you can optionally add the version labels for

the affected versions. This helps readers in knowing whether their issue
has been solved for their Python version.
Comment on lines +110 to +112
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So do you add the version labels for the versions where it has been fixed, or those where it's still an outstanding issue?

Copy link
Member Author

@picnixz picnixz Aug 7, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I personally don't add them because it's usually rare that I actually take very old issues, fix them, and close them. But I think it could be helpful for people who don't want to look at the commit itself and check to which branch it belongs. OTOH, we could just add a comment (Victor usually adds a comment saying in which commit it was fixed, but we could add "fixed in 3.X by commit ...".

This is something I actually wanted feedback on. Which would be the best for us?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think leave it out, labelling closed issues isn't the best use of limited volunteer time, and I doubt closed issues are checked very much. We have the linked PRs if you want to check what fixes were actually made.


- EOL version labels should be removed when possible but there is no need
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- EOL version labels should be removed when possible but there is no need
- Labels for end-of-life versions should be removed when possible but there is no need

to explicitly go through old issues to remove such labels.

- Otherwise, add the corresponding version label(s) and remember to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Otherwise, add the corresponding version label(s) and remember to
- Otherwise, add the corresponding version labels and remember to

update them when the latest major version is updated.

See also :ref:`the branch status page <branchstatus>`
for a list of active branches.

.. _exceptional-version-labels:

Exceptional version labels for features
---------------------------------------

While features should not have a version label, there are a few exceptional
cases subject to the release manager approval:

- If we are currently in the *beta* period of :samp:`3.{N}.0` and
if a feature was implemented in its *alpha* period but requires a
non-trivial extension (hence a new *feature* issue), this new
feature issue is given the :samp:`3.{N}` label as the latest
version under development would now be :samp:`3.{N+1}.0a1`.

To indicate that the labelling is correct and the extension is
approved, the :gh-label:`triaged` label could also be applied.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
approved, the :gh-label:`triaged` label could also be applied.
approved, the :gh-label:`triaged` label can also be applied.

Little grammar nit

Comment on lines +131 to +138
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, not sure if we need this? And I'm not sure about the triage label suggestion, it doesn't really say anything more than "issue is accepted by a triager".

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, it's for a visual tag. Sometimes I don't remember the issues I've triaged. And if I see an issue with weird label I would say "oh this one could have been mistriaged maybe". But with a triaged label, I know that I don't need to change the labels (same for when I lack a topic-* or a directory for an issue; when there is just "type-bug" it's kind of .. hard to know that there is actually a project associated to the issue; projects can't be seen on the issue page)



.. _Keywords:
.. _Other:
Expand Down
Loading