[docs] [issue37611] Improve the "Dealing with Bugs" documentation, include guidelines on how to report bugs
report at bugs.python.org
Wed Jul 17 13:42:36 EDT 2019
New submission from Mariatta <mariatta at python.org>:
On the left of docs.python.org, is a link to "Report a Bug", which takes you to "Dealing with Bugs" section (https://docs.python.org/3/bugs.html)
One of the first few paragraphs of the page is telling people that documentation bugs can be reported at the bug tracker, or if they're short on time, it can be emailed to docs at python.org.
The next section is talking about "using issue tracker", and at the very bottom are two links to external resources about how to report bugs effectively and bug reporting guidelines.
1. It would be great if the guidelines are at the top, instead of the bottom.
2. It would be great if we provide our own set of guidelines, instead of linking to external resources.
I think the guidelines are especially important for people who opted to write an email instead of creating an issue in bpo. In bpo, user is kinda restricted/reminded to select a specific type/component, but writing email can be more freeform. The better email they write, the easier it is for us to respond to them.
assignee: docs at python
nosy: Mariatta, docs at python
stage: needs patch
title: Improve the "Dealing with Bugs" documentation, include guidelines on how to report bugs
Python tracker <report at bugs.python.org>
More information about the docs