Improve the "Dealing with Bugs" documentation, include guidelines on how to report bugs
Open
Nobody has claimed this yet.
docs
type-feature
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
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 = []
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Find the existing “Dealing with Bugs” documentation in the CPython docs and read its current guidance. Add guidelines explaining how users should report bugs, then verify that the section clearly covers the requested reporting process and follows the surrounding documentation style.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100