Task: improve the "Using issue tracker" section
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.1k
- Forks
- 1k
- Avg merge
- 2d 12h
- Merged PRs (30d)
- 12
Description
The Using issue tracker page seems to describe how to use issue tracker for people who want to report a bug and how to help triage issue.
Seeing this is the developer's guide (aka contributing to Python guide), it would be great if there are sections dedicated for how to search for issues to start contributing.
Even the section about what each fields in the issue tracker mean, perhaps it can be moved outside of the "triaging" section. Those info are useful for general contributors too, not just for triagers. A first time contributor might decide to skip that section entirely, because they don't have triage role, and therefore missing out important information.
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
Start with the Using issue tracker page at devguide.python.org/tracker/ and the Fields in the issue tracker section of the triaging page. Review how contributors currently find issues and decide where the field explanations belong. Done means the guide includes contributor-focused issue-search guidance and makes the field information discoverable outside triaging.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100