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.

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
Changes from all commits
Commits
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
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:

- 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
the affected versions. This helps readers in knowing whether their issue
has been solved for their Python version.

- EOL version labels 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
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.


.. _Keywords:
.. _Other:
Expand Down
Loading
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy