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
Prev Previous commit
Next Next commit
Edits per @csabella @brettcannon review
  • Loading branch information
@willingc
willingc committed Mar 13, 2018
commit 77afdbed563f79ba04c86c4e4e5771b46fe8641e
25 changes: 16 additions & 9 deletions triaging.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Fields in the Issue Tracker

The major elements found in an issue report include:

* Classification (including *Title*) - These fields categorize the issue
* Classification (including *Title*) - These fields categorize the issue.
The fields include *Title*, *Type*, *Stage*, *Components*, and *Version*.
* Process - These fields indicate the state of the issue and its progress
toward resolution. The fields are *Status*, *Resolution*, *Dependencies*,
Expand All @@ -28,6 +28,9 @@ Title
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.


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.
Copy link
Copy Markdown
Contributor

@ncoghlan ncoghlan Mar 14, 2018

Choose a reason for hiding this comment

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

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)

Copy link
Copy Markdown
Collaborator Author

@willingc willingc Mar 14, 2018

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.


Type
''''
Describes the type of issue. If an issue does not fit within any
Expand All @@ -49,7 +52,7 @@ specific type, please do not set a type.
| | 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 |
| | prior to filing an issue is `python-ideas`_ mailing |
| | list. |
+----------------+----------------------------------------------------------+
| performance | Situations where too much time is necessary to complete |
Expand All @@ -60,8 +63,9 @@ specific type, please do not set a type.
| | used. |
+----------------+----------------------------------------------------------+
| security | Issues that might have security implications. Report |
| | security vulnerabilities which should not be made public |
| | to security@python.org. |
| | security vulnerabilities using the procedure found in |
| | the `Reporting security issues in Python`_ page on the |
| | python.org website. |
+----------------+----------------------------------------------------------+

Stage
Expand Down Expand Up @@ -342,7 +346,7 @@ Comment abbreviation can automatically generate a link to various web pages.
| ``pull request <number>`` | |
+-------------------------------------------------------------+-------------------------------------------------------+
| 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 |
| | generates a link to changeset ``<number>`` on GitHub |
| | or https://hg.python.org/. The ``git`` and ``hg`` |
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.

The markup is off on the description for commit number.

| | prefixes can also be used to disambiguate, and must |
| | precede the number without spaces. |
Expand Down Expand Up @@ -376,8 +380,10 @@ Checklist for Triaging

* Read the issue comment(s).
* Review and set classification fields
- Title: should be concise with specifics (such as Module name) which are
helpful to someone scanning a list of issue titles
- Title: should be concise with specifics which are helpful to someone
scanning a list of issue titles. 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.
- Type
- Stage
- Components: multiple items may be set
Expand All @@ -394,7 +400,6 @@ Checklist for Triaging
there is a long message list, a summary can be very helpful.



.. _CPython: https://github.com/python/cpython/
.. _Doc: https://github.com/python/cpython/tree/master/Doc/
.. _Grammar: https://github.com/python/cpython/tree/master/Grammar/
Expand Down Expand Up @@ -425,4 +430,6 @@ Checklist for Triaging
.. _GSoC: https://developers.google.com/open-source/gsoc/
.. _issue tracker: https://bugs.python.org
.. _GitHub pull requests: https://github.com/python/cpython/pulls>
.. _Python source code repositories: https://github.com/python/cpython/
.. _Python source code repositories: https://github.com/python/cpython/
.. _Reporting security issues in Python: https://www.python.org/news/security/
.. _python-ideas: https://mail.python.org/mailman/listinfo/python-ideas