Move "Helping Triage Issues" to triaging

python · ezio-melotti · Jul 11, 2022 · Jun 14, 2022 · Jun 15, 2022 · Jun 15, 2022
commit 8ef2a190491c9fc04d29dfdab11fa1dc4c4ebdff
diff --git a/triage/issue-tracker.rst b/triage/issue-tracker.rst
@@ -114,74 +114,6 @@ As a reminder, issues closed by a core developer have already been carefully
 considered. Please do not reopen a closed issue. An issue can be closed with
 reason either as ``complete`` or ``not planned``.
 
-.. _helptriage:
-
-Helping Triage Issues
-=====================
-
-Once you know your way around how Python's source files are
-structured and you are comfortable working with patches, a great way to
-contribute is to help triage issues. Do realize, though, that experience
-working on Python is needed in order to effectively help triage.
-
-Around the clock, new issues are being opened on the `issue tracker`_ and
-existing issues are being updated. Every issue needs to be triaged to make
-sure various things are in proper order. Even without special privileges you
-can help with this process.
-
-Classifying Reports
--------------------
-
-For bugs, an issue needs to:
-
-* clearly explain the bug so it can be reproduced
-* include all relevant platform details
-* state what version(s) of Python are affected by the bug.
-
-These are things you can help with once you have experience developing for
-Python:
-
-* try reproducing the bug: For instance, if a bug is not clearly explained
-  enough for you to reproduce it then there is a good chance a core developer
-  won't be able to either.
-* see if the issue happens on a different Python version: It is always helpful
-  to know if a bug not only affects the in-development version of Python, but
-  whether it also affects other versions in maintenance mode.
-* write a unit test: If the bug lacks a unit test that should end up in
-  Python's test suite, having that written can be very helpful.
-
-This is all helpful as it allows triagers (i.e.,
-:ref:`people with the Developer role on the issue tracker <triagers>`) to
-properly classify an issue so it can be handled by the right core developers in
-a timely fashion.
-
-Reviewing Patches
------------------
-
-If an issue has a pull request attached that has not been reviewed, you can help
-by making sure the patch:
-
-* follows the style guides
-* applies cleanly to an up-to-date clone
-* is a good solution to the problem it is trying to solve
-* includes proper tests
-* includes proper documentation changes
-* submitter is listed in ``Misc/ACKS``, either already or the patch adds them
-
-Doing all of this allows core developers and :ref:`triagers` to more
-quickly look for subtle issues that only people with extensive experience
-working on Python's code base will notice.
-
-Finding an Issue You Can Help With
-----------------------------------
-
-If you want to help triage issues, you might also want to search for issues
-in modules which you have a working knowledge.  Search for the name of a module
-in the issue tracker or use the `advanced search`_ query builder to search for
-specific kinds of issues (e.g. the "Windows" label if you are a Windows
-developer, "Extension Modules" if you are familiar with C, etc.).
-
-
 .. seealso::
 
    `The Python issue tracker <https://github.com/python/cpython/issues>`_

diff --git a/triage/triaging.rst b/triage/triaging.rst
@@ -1,7 +1,8 @@
 .. _triaging:
 
-Triaging an Issue
-=================
+===================
+ Triaging an Issue
+===================
 
 This section of the devguide documents the :ref:`issue tracker <tracker>` for
 users and developers.
@@ -11,7 +12,7 @@ directly without any assistance.
 
 
 Checklist for Triaging
-----------------------
+======================
 
 * Read the issue comment(s).
 * Review and set classification fields
@@ -32,3 +33,73 @@ Checklist for Triaging
     - Keywords
 * (Optional) Leave a brief comment about the proposed next action needed. If
   there is a long message list, a summary can be very helpful.
+
+
+.. _helptriage:
+
+Helping Triage Issues
+=====================
+
+Once you know your way around how Python's source files are
+structured and you are comfortable working with patches, a great way to
+contribute is to help triage issues. Do realize, though, that experience
+working on Python is needed in order to effectively help triage.
+
+Around the clock, new issues are being opened on the :ref:`issue tracker
+<tracker>` and existing issues are being updated. Every issue needs to be
+triaged to make sure various things are in proper order. Even without special
+privileges you can help with this process.
+
+Classifying Reports
+-------------------
+
+For bugs, an issue needs to:
+
+* clearly explain the bug so it can be reproduced
+* include all relevant platform details
+* state what version(s) of Python are affected by the bug.
+
+These are things you can help with once you have experience developing for
+Python:
+
+* try reproducing the bug: For instance, if a bug is not clearly explained
+  enough for you to reproduce it then there is a good chance a core developer
+  won't be able to either.
+* see if the issue happens on a different Python version: It is always helpful
+  to know if a bug not only affects the in-development version of Python, but
+  whether it also affects other versions in maintenance mode.
+* write a unit test: If the bug lacks a unit test that should end up in
+  Python's test suite, having that written can be very helpful.
+
+This is all helpful as it allows triagers (i.e.,
+:ref:`people with the Developer role on the issue tracker <triagers>`) to
+properly classify an issue so it can be handled by the right core developers in
+a timely fashion.
+
+Reviewing Patches
+-----------------
+
+If an issue has a pull request attached that has not been reviewed, you can help
+by making sure the patch:
+
+* follows the style guides
+* applies cleanly to an up-to-date clone
+* is a good solution to the problem it is trying to solve
+* includes proper tests
+* includes proper documentation changes
+* submitter is listed in ``Misc/ACKS``, either already or the patch adds them
+
+Doing all of this allows core developers and :ref:`triagers` to more
+quickly look for subtle issues that only people with extensive experience
+working on Python's code base will notice.
+
+Finding an Issue You Can Help With
+----------------------------------
+
+If you want to help triage issues, you might also want to search for issues
+in modules which you have a working knowledge.  Search for the name of a module
+in the issue tracker or use the `advanced search`_ query builder to search for
+specific kinds of issues (e.g. the "Windows" label if you are a Windows
+developer, "Extension Modules" if you are familiar with C, etc.).
+
+.. _advanced search: https://github.com/search/advanced