Skip to content

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.

Sign up for GitHub

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

Merged
willingc merged 13 commits into from
Mar 14, 2018
Merged

Update triage page with tables #339

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
21dabaa
Update triage page to change type section to table
willingc Mar 11, 2018
b0697b6
Convert Stage to a table
willingc Mar 11, 2018
1d2b651
Convert tables and add initial checklist
willingc Mar 11, 2018
bbf39d8
Convert comment section to table
willingc Mar 12, 2018
a96ed8a
Fix typos
willingc Mar 12, 2018
bd16b7a
Add content about sections in an issue and to checklist
willingc Mar 12, 2018
42f74ec
Correct wonky indentation
willingc Mar 12, 2018
efec7c8
Update intro as bpo links to this section as its documentation
willingc Mar 12, 2018
77afdbe
Edits per @csabella @brettcannon review
willingc Mar 13, 2018
fc63ad9
Clarify later and postponed per mailing list post
willingc Mar 13, 2018
577c560
Add pull request as suggested by @ncoghlan
willingc Mar 14, 2018
afacd4e
Fix typos
willingc Mar 14, 2018
0a23131
Edits per @ncoghlan review
willingc Mar 14, 2018
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
Next Next commit
Update triage page to change type section to table
  • Loading branch information
@willingc
willingc committed Mar 11, 2018
commit 21dabaad53c7b27aa0c5c3ffc1a21aae99d3adc3
91 changes: 51 additions & 40 deletions triaging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,66 +11,77 @@ Fields

Title
'''''
Should be properly descriptive of what the issue is about. Occasionally
people file an issue that either has too generic of a title or end up thinking
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.
Copy link
Copy Markdown
Contributor

@csabella csabella Mar 12, 2018

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.

Copy link
Copy Markdown
Collaborator Author

@willingc willingc Mar 12, 2018

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?

Copy link
Copy Markdown
Contributor

@csabella csabella Mar 12, 2018

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 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).

Copy link
Copy Markdown
Collaborator Author

@willingc willingc Mar 13, 2018

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.


Type
''''
Describes the type of issue. If something does not fit within any
specific type then simply do not set it.

behavior
Wrong or unexpected behavior, result, or exception. This includes most of
the bugs.
crash
Hard crashes of the Python interpreter -- possibly with a core
dump or a Windows error box.
compile error
Errors reported by the compiler while compiling Python.
resource usage
Situations where too many resources (e.g. memory) are used.
security
Issues that might have security implications. If you think the issue
should not be made public, please report it to security@python.org instead.
performance
Situations where too much time is necessary to complete the task.
enhancement
Issues that propose the addition of new functionality, such as new
functions, classes, modules, or even new arguments for existing functions.
Also used for improvements in the documentation and test suite and for
other refactorings.
Describes the type of issue. If an issue does not fit within any
specific type, please do not set a type.

+----------------+----------------------------------------------------------+
| Type | Description |
+================+==========================================================+
| behavior | Unexpected behavior, result, or exception. Most bugs |
| | will have this type. |
+----------------+----------------------------------------------------------+
| compile error | Errors reported by the compiler while compiling Python. |
+----------------+----------------------------------------------------------+
| crash | Hard crashes of the Python interpreter -- possibly with |
| | a core dump or a Windows error box. |
+----------------+----------------------------------------------------------+
| enhancement | Issues that propose the addition of new functionality, |
| | such as new functions, classes, modules, or even new |
| | 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 |
Copy link
Copy Markdown
Contributor

@csabella csabella Mar 12, 2018

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?

| | list. |
+----------------+----------------------------------------------------------+
| performance | Situations where too much time is necessary to complete |
| | the task. For example, a common task now takes |
| | significantly longer to complete. |
+----------------+----------------------------------------------------------+
| resource usage | Situations where too many resources (e.g. memory) are |
| | used. |
+----------------+----------------------------------------------------------+
| security | Issues that might have security implications. Report |
| | security vulnerabilities which should not be made public |
| | to security@python.org. |
Copy link
Copy Markdown
Member

@brettcannon brettcannon Mar 12, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

+----------------+----------------------------------------------------------+

Stage
'''''
What is needed next to advance the issue. The *stage* needn't be set until
it is clear that the issue warrants fixing.
A needed next action to advance the issue. The *stage* needn't be set until
it is clear that the issue has been initially triaged and determined work
will be needed.

test needed
The bug reporter should post a script or instructions to let a triager or
developer reproduce the issue.
The steps which are needed to reproduce the issue. The bug reporter
should post a script, instructions, or example to help someone test or
reproduce the issue.
needs patch
The issue lacks a patch to solve the problem (i.e. fixing the bug, or
The issue needs a patch to solve the problem (i.e. fixing the bug or
adding the requested improvement).
patch review
There is a patch, but it needs reviewing or is in the process of being
A patch exists, but it needs reviewing or is in the process of being
reviewed. This can be done by any triager as well as a core developer.
commit review
A triager performed a patch review and it looks good to them, but a core
developer needs to commit the patch (and do a quick once-over to make sure
nothing was overlooked).
A triager performed a patch review and it looks good. This signals to
core developers the patch is ready for a quick once-over to
make sure nothing was overlooked before committing the patch.
resolved
The issue is considered closed and dealt with.
The issue is considered closed and addressed (i.e. patch committed or
expected behavior and not a bug).

Components
''''''''''
What part of Python is affected by the issue. This is a multi-select field.
Be aware that what component is chosen may cause the issue to be auto-assigned,
The area or Python library affected by the issue. This is a multi-select field.
Some chosen components may cause the issue to be auto-assigned,
i.e. the issue tracker may automatically fill in the `Assigned To`_ field
after you press ``Submit changes``.

The following component(s) should be selected if the issue applies to:
The following component(s) may be selected for an issue:

2to3 (2.x to 3.0 conversion tool)
The 2to3 conversion tool in `Lib/lib2to3`_.
Expand Down