classification
Title: Improve the "Dealing with Bugs" documentation, include guidelines on how to report bugs
Type: enhancement Stage: needs patch
Components: Documentation Versions:
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Krishna Oza, Mariatta, docs@python
Priority: normal Keywords:

Created on 2019-07-17 17:42 by Mariatta, last changed 2019-07-19 15:25 by Mariatta.

Messages (3)
msg348077 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2019-07-17 17:42
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@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.
msg348176 - (view) Author: Krishna Oza (Krishna Oza) * Date: 2019-07-19 13:48
Mariatta,
Would it be okay for now just to move the existing bug filing guidelines to be moved up.
msg348180 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2019-07-19 15:25
Sure, moving it up is a good start.
History
Date User Action Args
2019-07-19 15:25:23Mariattasetmessages: + msg348180
2019-07-19 13:48:50Krishna Ozasetnosy: + Krishna Oza
messages: + msg348176
2019-07-17 17:42:36Mariattacreate