-
-
Notifications
You must be signed in to change notification settings - Fork 940
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
picnixz
wants to merge
3
commits into
python:main
Choose a base branch
from
picnixz:feat/workflow/triage-version-labels
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+35
−1
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -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. | ||||||||||
|
|
@@ -97,9 +98,42 @@ 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. | ||||||||||
|
|
||||||||||
| 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. | ||||||||||
|
|
||||||||||
| - 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 labels and remember to | ||||||||||
| update them when the latest major version is updated. | ||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's prefer "feature release" (or similar):
Suggested change
Suggested change
|
||||||||||
|
|
||||||||||
| 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`. | ||||||||||
|
Comment on lines
+128
to
+132
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you split this long sentence into shorter ones? |
||||||||||
|
|
||||||||||
| To indicate that the labelling is correct and the extension is | ||||||||||
| approved, the :gh-label:`triaged` label can also be applied. | ||||||||||
|
|
||||||||||
|
|
||||||||||
| .. _Keywords: | ||||||||||
| .. _Other: | ||||||||||
|
|
||||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe add a recommendation about whether to keep
type-bugintype-securityissues (are they truly redundant?)?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that the place for that is beside the type-security doc?