python / python/devguide

Clarify policy regarding 1 issue per pull request

Open
#494 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted topic-pull requests type-bug type-feature
Dominant language
Python
Stars
2.1k
Forks
1k
Avg merge
2d 12h
Merged PRs (30d)
12

Description

In python-dev mailing list, it was asked what to do when a PR will address multiple issues.
https://mail.python.org/archives/list/python-dev@python.org/thread/74FS2DW2L4MDJXRREAABXYRWNI6INMBA/

From few answers from the core devs, seems like we prefer keeping only one issue open (the oldest one), and mark the rest as duplicates. Also, our workflow (bots and blurb) kinda expects 1 bpo issue per 1 pull request.

It would be great to clarify all of the above in either the pull request life cycle page, or in the triaging page.

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

Read the linked python-dev mailing-list discussion and the devguide triaging page, including its pull request life cycle guidance. Clarify whether one issue should remain open per pull request, that the oldest issue is retained and others marked duplicates, and how bots and blurb handle this; done means the policy is documented in the appropriate page.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.