Repository navigation
Improve the "Dealing with Bugs" documentation, include guidelines on how to report bugs #81792
Description
| BPO | 37611 |
|---|---|
| Nosy | @kmoza, @Mariatta |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = None
created_at = <Date 2019-07-17.17:42:36.597>
labels = ['type-feature', 'docs']
title = 'Improve the "Dealing with Bugs" documentation, include guidelines on how to report bugs'
updated_at = <Date 2019-07-19.15:25:23.693>
user = 'https://github.com/Mariatta'bugs.python.org fields:
activity = <Date 2019-07-19.15:25:23.693>
actor = 'Mariatta'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2019-07-17.17:42:36.597>
creator = 'Mariatta'
dependencies = []
files = []
hgrepos = []
issue_num = 37611
keywords = []
message_count = 3.0
messages = ['348077', '348176', '348180']
nosy_count = 3.0
nosy_names = ['docs@python', 'Krishna Oza', 'Mariatta']
pr_nums = []
priority = 'normal'
resolution = None
stage = 'needs patch'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue37611'
versions = []
Activity
Mariatta commentedon Jul 17, 2019
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.
It would be great if the guidelines are at the top, instead of the bottom.
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.
kmoza commentedon Jul 19, 2019
Mariatta,
Would it be okay for now just to move the existing bug filing guidelines to be moved up.
Mariatta commentedon Jul 19, 2019
Sure, moving it up is a good start.
jacalata commentedon Jun 25, 2022
It seems like the page "Dealing with Bugs" could be replaced with a link to https://devguide.python.org/tracker/
and (About these documents) could be replaced with a link to https://devguide.python.org/docquality/?