Skip to content

Commit 46b4a82

Browse files
Update the triage/triaging.rst page. (#914)
* Update the triage/triaging.rst page. * Mention the `triaged` label + more tweaks. * Fix markup. * Add a link to the `triaged` label. * Apply suggestions from code review Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> * Address more review comments. * Apply suggestions from code review Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
1 parent 2150d0d commit 46b4a82

File tree

2 files changed

+44
-48
lines changed

2 files changed

+44
-48
lines changed

core-developers/committing.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,8 @@ to enter the public source tree. Ask yourself the following questions:
7575
require a ``NEWS`` entry. (See the following section for more information.)
7676

7777

78+
.. _news-entry:
79+
7880
Updating NEWS and What's New in Python
7981
--------------------------------------
8082

triage/triaging.rst

Lines changed: 42 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,26 @@ Triaging an Issue
77
This section of the devguide documents the :ref:`issue tracker <tracker>` for
88
users and developers.
99

10-
Contributors with the Triager role on the issue tracker can triage issues
11-
directly without any assistance.
12-
1310

1411
Checklist for Triaging
1512
======================
1613

17-
* Read the issue comment(s).
18-
* Review and set classification fields
19-
- Title: should be concise with specifics which are helpful to someone
20-
scanning a list of issue titles. (Optional, if possible) Add a
21-
prefix at the start of the title to indicate the module, e.g. IDLE,
22-
doc, or async.
23-
- Type
24-
- Stage
25-
- Components: multiple items may be set
26-
- Versions: set if known, leave blank if unsure. Multiple items may be set.
27-
* Review and set process fields
28-
- Status
29-
- Superseder
30-
- Assignees
31-
- Nosy List
32-
- Priority
33-
- Keywords
34-
* (Optional) Leave a brief comment about the proposed next action needed. If
35-
there is a long message list, a summary can be very helpful.
14+
* Read the initial message and the comments.
15+
* Check that the title is reasonably concise, while including enough specifics
16+
so that those scanning the list of issues can quickly identify its topic.
17+
* For pull requests, ensure that the corresponding issue is added before
18+
the title (:samp:`gh-NNNNN: {Title}`).
19+
* Set all the relevant :ref:`labels <gh-labels>`.
20+
* Where appropriate, set the :guilabel:`Assignees`, :guilabel:`Reviewers`,
21+
:guilabel:`Project` fields, and possibly @mention relevant people.
22+
* You might also leave a brief comment about the proposed next action needed.
23+
If there is a long message list, a summary can be very helpful.
24+
* If the issue is clearly invalid (unrelated to CPython, duplicate, spam, etc),
25+
you can close it as "not planned".
26+
27+
.. Remove note once python/core-workflow#460 is implemented
28+
29+
.. note:: Some of these fields can only be set/edited by core developers.
3630

3731

3832
.. _helptriage:
@@ -41,14 +35,13 @@ Helping Triage Issues
4135
=====================
4236

4337
Once you know your way around how Python's source files are
44-
structured and you are comfortable working with patches, a great way to
38+
structured and you are comfortable with the workflow, a great way to
4539
contribute is to help triage issues. Do realize, though, that experience
4640
working on Python is needed in order to effectively help triage.
4741

4842
Around the clock, new issues are being opened on the :ref:`issue tracker
4943
<tracker>` and existing issues are being updated. Every issue needs to be
50-
triaged to make sure various things are in proper order. Even without special
51-
privileges you can help with this process.
44+
triaged to make sure everything runs smoothly.
5245

5346
Classifying Reports
5447
-------------------
@@ -62,44 +55,45 @@ For bugs, an issue needs to:
6255
These are things you can help with once you have experience developing for
6356
Python:
6457

65-
* try reproducing the bug: For instance, if a bug is not clearly explained
66-
enough for you to reproduce it then there is a good chance a core developer
58+
* Try reproducing the bug: if it is not explained clearly
59+
enough for you to reproduce it, then there is a good chance a core developer
6760
won't be able to either.
68-
* see if the issue happens on a different Python version: It is always helpful
61+
* See if the issue happens on a different Python version: it is always helpful
6962
to know if a bug not only affects the in-development version of Python, but
7063
whether it also affects other versions in maintenance mode.
71-
* write a unit test: If the bug lacks a unit test that should end up in
64+
* Write a unit test: if the bug lacks a unit test that should end up in
7265
Python's test suite, having that written can be very helpful.
7366

74-
This is all helpful as it allows triagers (i.e.,
75-
:ref:`people with the Developer role on the issue tracker <triagers>`) to
76-
properly classify an issue so it can be handled by the right core developers in
77-
a timely fashion.
67+
This is all helpful as it allows members of the :ref:`triage team <triage-team>`
68+
to properly classify an issue so it can be handled by the right core developers
69+
in a timely fashion.
7870

79-
Reviewing Patches
80-
-----------------
71+
Reviewing Pull Requests
72+
-----------------------
8173

82-
If an issue has a pull request attached that has not been reviewed, you can help
83-
by making sure the patch:
74+
If an issue has a linked pull request that has not been reviewed,
75+
you can help by making sure the pull request:
8476

85-
* follows the style guides
86-
* applies cleanly to an up-to-date clone
8777
* is a good solution to the problem it is trying to solve
78+
* follows the style guides (:pep:`7`, :pep:`8`, :ref:`style-guide`, etc.)
8879
* includes proper tests
8980
* includes proper documentation changes
90-
* submitter is listed in ``Misc/ACKS``, either already or the patch adds them
81+
* includes a :ref:`NEWS entry <news-entry>` (if needed)
82+
* includes the author in ``Misc/ACKS``, either already or the patch adds them
83+
* doesn't have conflicts with the ``main`` branch
84+
85+
Doing all of this allows core developers and :ref:`triagers <triage-team>`
86+
to more quickly look for subtle issues that only people with extensive
87+
experience working on Python's code base will notice.
9188

92-
Doing all of this allows core developers and :ref:`triagers` to more
93-
quickly look for subtle issues that only people with extensive experience
94-
working on Python's code base will notice.
89+
See also :ref:`committing`.
9590

9691
Finding an Issue You Can Help With
9792
----------------------------------
9893

99-
If you want to help triage issues, you might also want to search for issues
100-
in modules which you have a working knowledge. Search for the name of a module
101-
in the issue tracker or use the `advanced search`_ query builder to search for
102-
specific kinds of issues (e.g. the "Windows" label if you are a Windows
103-
developer, "Extension Modules" if you are familiar with C, etc.).
94+
If you want to help with triaging, you might also want to search for issues
95+
in modules for which you have a working knowledge. Search for the name of a
96+
module in the issue tracker, filter by label, or use the `advanced search`_
97+
to find these issues.
10498

10599
.. _advanced search: https://github.com/search/advanced

0 commit comments

Comments
 (0)