Skip to content

Commit 4e6e10f

Browse files
ezio-melottiCAM-Gerlachhugovk
authored
Overhaul the labels page to reflect current GH labeling practice (#930)
* Update the triage/labels.rst page. * Remove duplicate label. * Use the `:gh-label:` role. * Use the `:cpy-file:` role. * (Re)move (mostly) BPO-related info. * Apply suggestions from code review Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> * Apply suggestions from code review Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Fix miss-islington link markup. * Add more ref targets to prevent link rotting. Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Add other two ref targets to the "Type labels" section. * Address remaining review comments. * Apply more suggestions from code review. Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> * Rephrase sentence as suggested in a review comment. * Rewrap a few long lines. * Restore and move the `Assignees` sub-section. * Fix typo. Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Fix "triager" capitalization. Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> * Document the `automerge` label. * Remove obsolete note/comment. * Minor grammar/punctuation/phrasing fixes. Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> * Final tweaks. Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> --------- Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
1 parent 5803a02 commit 4e6e10f

File tree

6 files changed

+181
-399
lines changed

6 files changed

+181
-399
lines changed

getting-started/pull-request-lifecycle.rst

+3-1
Original file line numberDiff line numberDiff line change
@@ -402,6 +402,9 @@ on how to properly add the co-author info.
402402

403403
See also :ref:`Applying a Patch to Git <git_from_patch>`.
404404

405+
406+
.. _reviewing-prs:
407+
405408
Reviewing
406409
=========
407410

@@ -427,7 +430,6 @@ thus iterate until a satisfactory solution has emerged.
427430

428431
.. _how-to-review-a-pull-request:
429432

430-
431433
How to Review a Pull Request
432434
----------------------------
433435

getting-started/setup-building.rst

+1
Original file line numberDiff line numberDiff line change
@@ -577,6 +577,7 @@ support.
577577
For editors and tools which the core developers have felt some special comment
578578
is needed for coding *in* Python, see :ref:`resources`.
579579

580+
.. _build-directory-structure:
580581

581582
Directory structure
582583
===================

triage/issue-tracker.rst

+39-8
Original file line numberDiff line numberDiff line change
@@ -84,16 +84,44 @@ The submission form has only two fields that you need to fill:
8484
information as appropriate). In particular, *what version of Python* you
8585
were using.
8686

87-
Understanding the issue's progress and status
88-
---------------------------------------------
89-
90-
There is a number of additional fields like **Assignees**, **Labels**,
91-
**Projects**, and **Milestone**. Those are filled by triagers and core
92-
developers, this is covered in the :ref:`triaging` page. You don't need
87+
You can tag someone, with :samp:`@{username}` in a comment,
88+
if you think the issue should be brought to their attention.
89+
Use the :ref:`experts` to know who wants to be
90+
tagged or assigned for specific areas.
91+
92+
There are a number of additional fields like **Assignees**, **Labels**,
93+
and **Projects**. Those are filled by triagers and core
94+
developers and are covered in the :ref:`triaging` page. You don't need
9395
to worry about those when reporting issues as a Python user.
9496

95-
You will automatically receive an update each time an action is taken on
96-
the bug, unless you changed your GitHub notification settings.
97+
Adding special links
98+
--------------------
99+
100+
The following abbreviations can be used in a comment to generate a link:
101+
102+
* :samp:`GH-{NNN}`: to link to another issue or PR;
103+
* :samp:`PEP-{NNN}`: to link to a specific PEP;
104+
* :samp:`BPO-{NNN}`: to link to a bugs.python.org issue;
105+
106+
See also the `list of autolinks supported by GitHub <autolinks_>`_.
107+
108+
Following issues
109+
----------------
110+
111+
If you want to subscribe yourself to an issue, click the :guilabel:`🔔 Subscribe`
112+
button in the sidebar. Similarly, if you were tagged by somebody else but
113+
decided this issue is not for you, click the :guilabel:`🔕 Unsubscribe`
114+
button in the sidebar. Note that you are automatically subscribed to
115+
issues you created.
116+
117+
Tracking dependencies and duplicates
118+
------------------------------------
119+
120+
It is possible to use `checklists`_ to track dependencies or,
121+
in case of meta-issues, to link to the other related issues.
122+
123+
By writing :samp:`Duplicate of #{NNN}` in a comment, you can
124+
`mark issues and PRs as duplicates <duplicates_>`_.
97125

98126

99127
Disagreement With a Resolution on the Issue Tracker
@@ -128,4 +156,7 @@ reason either as ``complete`` or ``not planned``.
128156
.. _devguide repo: https://github.com/python/devguide/issues
129157
.. _Roundup: https://roundup.sourceforge.io/
130158
.. _Python Discourse: https://discuss.python.org/
159+
.. _autolinks: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls
160+
.. _checklists: https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists
161+
.. _duplicates: https://docs.github.com/en/issues/tracking-your-work-with-issues/marking-issues-or-pull-requests-as-a-duplicate
131162
.. _Core Development Discourse category: https://discuss.python.org/c/core-dev/23

0 commit comments

Comments
 (0)