Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork855
Update triage page with tables#339
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
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'. |
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. |
triaging.rst Outdated
| | | 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). | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
'if the necessary information' is missing the verb.
triaging.rst Outdated
| | 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. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
What is the difference betweenpostponed andlater?
triaging.rst Outdated
| +-------------------------------------------------------------+-------------------------------------------------------+ | ||
| | 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`` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
The markup is off on the description for commit number.
triaging.rst Outdated
| | | 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 | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Can python-ideas be a link?
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Let's recommend that folks do as you suggest. Do you have a format that has worked well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Thanks for asking! :-) Well, for IDLE, we useIDLE: 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 thezlib andzip 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).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
@csabella Added below and in the checklist.
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? |
@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. |
triaging.rst Outdated
| +----------------+----------------------------------------------------------+ | ||
| | security | Issues that might have security implications. Report | | ||
| | | security vulnerabilities which should not be made public | | ||
| | | to security@python.org. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Should probably link tohttps://www.python.org/news/security/ as it has e.g. PGP key to use.
@csabella@brettcannon I think that I've covered your review comments. I've removed the WIP. |
LGTM. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
triaging.rst Outdated
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
For most modules, and evendoc 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 calledIDLE)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Going to fix this as a I see a typo as well.
triaging.rst Outdated
| | | 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 | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Great point. Will add pull request.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Good suggestion. Will do.
triaging.rst Outdated
| 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*. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Should we link tohttps://devguide.python.org/#status-of-python-branches here, and perhaps add the RM's tracker ID's to that table?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Good suggestion@ncoghlan. Where is the RM's tracker ID?
triaging.rst Outdated
| * ``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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Perhaps "Using the following abbreviations in a comment will automatically generate a link to relevant web pages."
I've gone ahead and merged. Further changes can be handled in future PRs. Thanks@csabella@brettcannon and@ncoghlan for the reviews 💐 |
Thanks for working on this@willingc, the new version looks great! |
* 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
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".