Skip to content
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

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

Merged
merged 22 commits into from
Mar 16, 2023
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
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
4 changes: 3 additions & 1 deletion getting-started/pull-request-lifecycle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,9 @@ on how to properly add the co-author info.

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


.. _reviewing-prs:

Reviewing
=========

Expand All @@ -428,7 +431,6 @@ thus iterate until a satisfactory solution has emerged.

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


How to Review a Pull Request
----------------------------

Expand Down
1 change: 1 addition & 0 deletions getting-started/setup-building.rst
Original file line number Diff line number Diff line change
Expand Up @@ -577,6 +577,7 @@ support.
For editors and tools which the core developers have felt some special comment
is needed for coding *in* Python, see :ref:`resources`.

.. _build-directory-structure:

Directory structure
===================
Expand Down
47 changes: 39 additions & 8 deletions triage/issue-tracker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -84,16 +84,44 @@ The submission form has only two fields that you need to fill:
information as appropriate). In particular, *what version of Python* you
were using.

Understanding the issue's progress and status
---------------------------------------------

There is a number of additional fields like **Assignees**, **Labels**,
**Projects**, and **Milestone**. Those are filled by triagers and core
developers, this is covered in the :ref:`triaging` page. You don't need
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 or assigned for specific areas.

There are a number of additional fields like **Assignees**, **Labels**,
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.

You will automatically receive an update each time an action is taken on
the bug, unless you changed your GitHub notification settings.
Adding special links
--------------------

The following abbreviations can be used in a comment to generate a link:

* :samp:`GH-{NNN}`: to link to another issue or PR;
* :samp:`PEP-{NNN}`: to link to a specific PEP;
* :samp:`BPO-{NNN}`: to link to a bugs.python.org issue;

See also the `list of autolinks supported by GitHub <autolinks_>`_.

Following issues
----------------

If you want to subscribe yourself to an issue, click the :guilabel:`🔔 Subscribe`
button in the sidebar. Similarly, if you were tagged by somebody else but
decided this issue is not for you, click the :guilabel:`🔕 Unsubscribe`
button in the sidebar. Note that you are automatically subscribed to
issues you created.

Tracking dependencies and duplicates
------------------------------------

It is possible to use `checklists`_ to track dependencies or,
in case of meta-issues, to link to the other related issues.

By writing :samp:`Duplicate of #{NNN}` in a comment, you can
`mark issues and PRs as duplicates <duplicates_>`_.
CAM-Gerlach marked this conversation as resolved.
Show resolved Hide resolved


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