python / python/devguide

Feature: Clarify that docs issues typically don't get version labels

Open
#1,674 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

topic-triage type-feature
Dominant language
Python
Stars
2.1k
Forks
1k
Avg merge
2d 12h
Merged PRs (30d)
12

Description

Describe the enhancement or feature you would like

In learning how to label / triage came across a docs issue where I got the labels fairly off and I would like to add more details to the devguide to help future triagers get it right the first time. In particular:

  1. docs issues don't typically get version labels (Those tend to only go with code changes)
  2. If there's no code change needed then stdlib, extension-modules, etc. tend not to apply.
Describe alternatives you have considered

No response

Additional context

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue does not name a devguide file or section; first locate the documentation about labeling and triage. Add guidance that docs issues usually do not receive version labels or code-area labels such as stdlib and extension-modules, then verify the wording fits the surrounding guidance.

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
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.