Update triage page with tables #339

willingc · 2018-03-11T18:22:57Z

The goal of this PR is to provide people new to triaging a cheatsheet-like view of the fields on bugs.python.org.

This is a first step in possibly creating a "triaging workgroup".

csabella · 2018-03-12T15:14:28Z

Wow, what a great idea. This is much clearer - thanks for all the work! :-)

One thing that I wanted to suggest, related to the bug tracker, but unrelated to this issue, is to put the relevant module as the first word in the title. I know that adding a new dropdown for module has been turned down several times, but I find that issues with the module as the first word are much easier to navigate (and to sort on). I only bring it up here because you changed the description for 'Title'.

willingc · 2018-03-12T15:42:44Z

Thank you @csabella. I was going to ping you later to see if you had time to review this WIP PR. Feel free to leave suggestions, clarifications, etc. directly in the code.

csabella · 2018-03-12T17:36:21Z

triaging.rst

+|               | information to reproduce the bug reported.  Requesting     |
+|               | additional information and setting status to *pending*     |
+|               | indicates that the issue should be closed if the necessary |
+|               | information in a timely manner (i.e. one month).           |


'if the necessary information' is missing the verb.

csabella · 2018-03-12T17:37:34Z

triaging.rst

+| out of date   | The issue has already been fixed, or the problem doesn't   |
+|               | exist anymore for other reasons.                           |
+---------------+------------------------------------------------------------+
+| postponed     | Issue will not be worked on at the moment.                 |


What is the difference between postponed and later?

csabella · 2018-03-12T17:39:58Z

triaging.rst

+-------------------------------------------------------------+-------------------------------------------------------+
+| a 10-, 11-, 12-, or 40-digit hex ``<number>``               | Indicates a Git or Mercurial changeset identifier and |
+|                                                             | generates a link to changeset ``<number>``on GitHub   | 
+|                                                             | or https://hg.python.org/. The ``git`` and ``hg``     |


The markup is off on the description for commit number.

csabella · 2018-03-12T17:41:45Z

triaging.rst

+|                | arguments for existing functions. Also used for          |
+|                | improvements in the documentation, test suite and        |
+|                | other refactorings. A good place to discuss enhancements |
+|                | prior to filing an issue is **python-ideas** mailing     |


Can python-ideas be a link?

csabella · 2018-03-12T18:00:07Z

triaging.rst

-they filed about X but in fact it turns out to be about Y and thus the
-title is now wrong.
+A brief description of the issue. Review whether the title is too generic or
+specifies an incorrect term or library.


I mentioned this in my other comment, but mentioning it here too. This may need to be a new issue for further discussion. I think it would be helpful for the title to begin with the module that the issue is for. A large portion of the tickets have this now, but not all of them. It makes search (and sorting) easier to find tickets related to a module.

Let's recommend that folks do as you suggest. Do you have a format that has worked well?

Thanks for asking! :-) Well, for IDLE, we use IDLE: and I think that let's everyone know they can skip it. :-) Seriously though, if you go into the bug tracker and then search, then click 'Sort on' next to title, you'll see (with sort descending), that the zlib and zip modules come up first. That's really just the format I'd suggest, putting the module first instead of somewhere else in the title. I don't think a colon after it is necessary, unless it reads better. I've downloaded all the bugs using the .csv download and realized this could make it a lot easier for people to find related tickets. The old 'I think there's a ticket for this, but I can't find it' becomes easier when you can narrow the search. :-) It also gives a sense for the modules that may be neglected (for example, argparse has a ton of open tickets).

@csabella Added below and in the checklist.

csabella · 2018-03-12T18:54:15Z

One question that I had about triaging, especially old tickets, that you may or may not want to address on this page, is when is it helpful and when is it noise? I've been going through old documentation issues and marking some as 'easy' so that new contributors can find them more easily. I try to only do a few a week as to not make a lot of old tickets prominent. But, for example, there have been many issues that I have seen which could get the 'languishing' tag or have the title changed as per my previous suggestion. But, doing a lot of that at once would just be noise. Maybe you can suggest guidelines around that?

brettcannon · 2018-03-12T19:21:25Z

@csabella honestly, if you're motivated to update something manually, then just do it. 😄 Making sure something actually occurs rather than have it be forgotten is more important than worrying about people getting another email.

brettcannon · 2018-03-12T19:24:18Z

triaging.rst

+----------------+----------------------------------------------------------+
+| security       | Issues that might have security implications. Report     |
+|                | security vulnerabilities which should not be made public |
+|                | to [email protected].                                  |


Should probably link to https://www.python.org/news/security/ as it has e.g. PGP key to use.

willingc · 2018-03-13T04:41:12Z

@csabella @brettcannon I think that I've covered your review comments. I've removed the WIP.

csabella · 2018-03-13T21:47:54Z

LGTM.

ncoghlan

Thanks Carol, this looks like a really nice improvement to me!

A few comments and ideas inline, but nothing that I think should block the merge.

ncoghlan · 2018-03-14T12:34:43Z

triaging.rst

+specifies an incorrect term or library.
+
+Adding a prefix at the start of the title to indicate the module, such as 
+IDLE, DOC, or ASYNCIO, is optional, but can be helpful to others.


For most modules, and even doc as a pseudo-module, I'd suggest a lower case prefix - caps are kinda shouty. (IDLE is an exception, since the IDE itself actually is called IDLE)

Going to fix this as a I see a typo as well.

ncoghlan · 2018-03-14T12:38:12Z

triaging.rst

+|               | bug reporter should post a script, instructions, or      |
+|               | example to help someone test or reproduce the issue.     |
+---------------+----------------------------------------------------------+
+| needs patch   | A patch is needed to solve the problem (i.e. fixing the  |


Should we use "patch or pull request" in this table, with a short note below about their functional equivalence? They're pretty much interchangeable as far as the tracker is concerned, but readers that are only familiar with GitHub may not have encountered the "patch" term.

Great point. Will add pull request.

Good suggestion. Will do.

ncoghlan · 2018-03-14T12:41:16Z

triaging.rst

-in any doubt, add him or her to the *nosy list*.
+is a *release blocker* is decided by the release manager. Triagers may
+recommend this priority and should add the release manager to the 
+*nosy list*.


Should we link to https://devguide.python.org/#status-of-python-branches here, and perhaps add the RM's tracker ID's to that table?

Good suggestion @ncoghlan. Where is the RM's tracker ID?

ncoghlan · 2018-03-14T12:45:16Z

triaging.rst

-* ``devguide`` (lowercase), ``devguide/triaging``, and
-  ``devguide/triaging#generating-special-links-in-a-comment`` generate links to
-  the Devguide, this page, and this section respectively.
+Comment abbreviation can automatically generate a link to various web pages.


Perhaps "Using the following abbreviations in a comment will automatically generate a link to relevant web pages."

willingc · 2018-03-14T14:41:22Z

I've gone ahead and merged. Further changes can be handled in future PRs. Thanks @csabella @brettcannon and @ncoghlan for the reviews 💐

ezio-melotti · 2018-03-15T09:01:41Z

Thanks for working on this @willingc, the new version looks great!

@csabella

* Update triage page to change type section to table * Convert Stage to a table * Convert tables and add initial checklist * Convert comment section to table * Fix typos * Add content about sections in an issue and to checklist * Correct wonky indentation * Update intro as bpo links to this section as its documentation * Edits per @csabella @brettcannon review * Clarify later and postponed per mailing list post * Add pull request as suggested by @ncoghlan * Fix typos * Edits per @ncoghlan review

Update triage page to change type section to table

21dabaa

the-knights-who-say-ni added the CLA signed label Mar 11, 2018

willingc requested a review from brettcannon March 11, 2018 18:23

willingc added 4 commits March 11, 2018 13:03

Convert Stage to a table

b0697b6

Convert tables and add initial checklist

1d2b651

Convert comment section to table

bbf39d8

Fix typos

a96ed8a

Add content about sections in an issue and to checklist

bd16b7a

willingc added 2 commits March 12, 2018 08:50

Correct wonky indentation

42f74ec

Update intro as bpo links to this section as its documentation

efec7c8

csabella reviewed Mar 12, 2018

View reviewed changes

brettcannon reviewed Mar 12, 2018

View reviewed changes

willingc added 2 commits March 12, 2018 21:30

Edits per @csabella @brettcannon review

77afdbe

Clarify later and postponed per mailing list post

fc63ad9

willingc changed the title ~~[WIP] Update triage page with tables~~ Update triage page with tables Mar 13, 2018

ncoghlan approved these changes Mar 14, 2018

View reviewed changes

willingc added 3 commits March 14, 2018 07:11

Add pull request as suggested by @ncoghlan

577c560

Fix typos

afacd4e

Edits per @ncoghlan review

0a23131

willingc merged commit 5521c54 into python:master Mar 14, 2018

willingc deleted the triage-updates branch March 14, 2018 14:41

ezio-melotti mentioned this pull request Mar 15, 2018

Post-migration Devguide reorganization #120

Open

12 tasks

willingc restored the triage-updates branch June 28, 2019 19:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update triage page with tables #339

Update triage page with tables #339

willingc commented Mar 11, 2018

csabella commented Mar 12, 2018

willingc commented Mar 12, 2018

csabella Mar 12, 2018

csabella Mar 12, 2018

csabella Mar 12, 2018

csabella Mar 12, 2018

csabella Mar 12, 2018

willingc Mar 12, 2018

csabella Mar 12, 2018

willingc Mar 13, 2018

csabella commented Mar 12, 2018

brettcannon commented Mar 12, 2018

brettcannon Mar 12, 2018

willingc commented Mar 13, 2018

csabella commented Mar 13, 2018

ncoghlan left a comment

ncoghlan Mar 14, 2018

willingc Mar 14, 2018

ncoghlan Mar 14, 2018

willingc Mar 14, 2018

willingc Mar 14, 2018

ncoghlan Mar 14, 2018

willingc Mar 14, 2018 •

edited

Loading

ncoghlan Mar 14, 2018

willingc commented Mar 14, 2018

ezio-melotti commented Mar 15, 2018

Update triage page with tables #339

Update triage page with tables #339

Conversation

willingc commented Mar 11, 2018

csabella commented Mar 12, 2018

willingc commented Mar 12, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

csabella commented Mar 12, 2018

brettcannon commented Mar 12, 2018

Choose a reason for hiding this comment

willingc commented Mar 13, 2018

csabella commented Mar 13, 2018

ncoghlan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

willingc Mar 14, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

willingc commented Mar 14, 2018

ezio-melotti commented Mar 15, 2018

willingc Mar 14, 2018 •

edited

Loading