Skip to content

Overhaul the labels page to reflect current GH labeling practice #930

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

Merged
ezio-melotti merged 22 commits into from
Mar 16, 2023
Merged

Overhaul the labels page to reflect current GH labeling practice #930

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
ee69135
Update the triage/labels.rst page.
ezio-melotti Aug 6, 2022
74f0847
Merge branch 'main' into update-labels
ezio-melotti Dec 25, 2022
8e3928c
Remove duplicate label.
ezio-melotti Dec 25, 2022
f6ac25c
Use the `:gh-label:` role.
ezio-melotti Dec 25, 2022
82dae36
Use the `:cpy-file:` role.
ezio-melotti Dec 25, 2022
d51c027
(Re)move (mostly) BPO-related info.
ezio-melotti Dec 25, 2022
579b6a5
Apply suggestions from code review
ezio-melotti Dec 26, 2022
e5a4e09
Apply suggestions from code review
ezio-melotti Dec 27, 2022
9983fc2
Fix miss-islington link markup.
ezio-melotti Dec 27, 2022
a783cd3
Add more ref targets to prevent link rotting.
ezio-melotti Mar 14, 2023
eed6680
Add other two ref targets to the "Type labels" section.
ezio-melotti Mar 14, 2023
42842c4
Address remaining review comments.
ezio-melotti Mar 14, 2023
b3590e2
Apply more suggestions from code review.
ezio-melotti Mar 15, 2023
7c54ccf
Rephrase sentence as suggested in a review comment.
ezio-melotti Mar 15, 2023
89b29bb
Rewrap a few long lines.
ezio-melotti Mar 15, 2023
ee6fecd
Restore and move the `Assignees` sub-section.
ezio-melotti Mar 15, 2023
8d8a52b
Fix typo.
ezio-melotti Mar 16, 2023
52eea4d
Fix "triager" capitalization.
ezio-melotti Mar 16, 2023
5f1f478
Document the `automerge` label.
ezio-melotti Mar 16, 2023
4db1138
Remove obsolete note/comment.
ezio-melotti Mar 16, 2023
ff2d0ee
Minor grammar/punctuation/phrasing fixes.
ezio-melotti Mar 16, 2023
9b9482f
Final tweaks.
ezio-melotti Mar 16, 2023
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
Prev Previous commit
Next Next commit
Address remaining review comments.
  • Loading branch information
@ezio-melotti
ezio-melotti committed Mar 14, 2023
commit 42842c407d105ba6a4b5642a6d5770f5c4220f44
5 changes: 3 additions & 2 deletions triage/issue-tracker.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,10 +86,11 @@ The submission form has only two fields that you need to fill:

You can tag someone, with :samp:`@{username}` in a comment,
if you think the issue should be brought to their attention.
Use the :ref:`experts` to know who wants to be tagged for specific areas.
Use the :ref:`experts` to know who wants to be
tagged or assigned for specific areas.

There are a number of additional fields like **Assignees**, **Labels**,
**Projects**, and **Milestone**. Those are filled by triagers and core
and **Projects**. Those are filled by triagers and core
developers and are covered in the :ref:`triaging` page. You don't need
to worry about those when reporting issues as a Python user.

Expand Down
23 changes: 5 additions & 18 deletions triage/labels.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,6 @@ the only available labels are :gh-label:`OS-windows`, :gh-label:`OS-mac`,
and :gh-label:`OS-freebsd`.


.. _Versions:

Version labels
==============
Comment thread
ezio-melotti marked this conversation as resolved.

Expand Down Expand Up @@ -134,25 +132,14 @@ by bots, or added by humans to trigger specific bot behaviors.
* :gh-label:`skip news`: for PRs that don't need a NEWS entry.
The :ref:`news-entry` section covers in details in which cases the NEWS entry
can be skipped.
* :samp:`awaiting {action}`: these labels are applied and used by ``bedevere`` to
indicate the stage of a PR:

* :gh-label:`awaiting review`: the PR hasn't been reviewed and is waiting
for a review.
* :gh-label:`awaiting core review`: a review by a core developer is needed.
* :gh-label:`awaiting changes`: a reviewer requested changes to proceed with
the PR.
* :gh-label:`awaiting change review`: a review of the requested changes
is needed.
* :gh-label:`awaiting merge`: the PR has been approved by a core developer
and is ready to merge.

* :gh-label:`test-with-buildbots`: used to test the latest commit with
the buildbot fleet whenever more testing is required before merging.
This may take multiple hours to complete. Triagers can also stop
a stuck build using the web interface.
the :ref:`buildbot fleet <buildbots>` whenever more testing is required
before merging. This may take multiple hours to complete.
* :samp:`awaiting {action}`: these labels are applied and used by `bedevere`_
to indicate the stage of a PR and should not be applied manually.


.. _Reporting security issues in Python: https://www.python.org/dev/security/
.. _Ideas Discourse category: https://discuss.python.org/c/ideas/6
.. _miss-islington: https://github.com/python/miss-islington
.. _bedevere: https://github.com/python/bedevere/#pr-state-machine
2 changes: 1 addition & 1 deletion triage/triage-team.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ developer before taking any action.

Triagers can also make use of the :gh-label:`pending` and :gh-label:`stale` labels to suggest that a
PR may be suitable for closure. For more information, see the
:ref:`GitHub PR labels <gh-labels>` section.
:ref:`other` section.
Comment thread
ezio-melotti marked this conversation as resolved.
Outdated

Note that it is of paramount importance to treat every contributor to the Python
project kindly and with respect. Regardless of whether they're entirely new
Expand Down