Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify policy regarding 1 bpo issue per pull request #494

Open
Mariatta opened this issue Jun 11, 2019 · 2 comments
Open

Clarify policy regarding 1 bpo issue per pull request #494

Mariatta opened this issue Jun 11, 2019 · 2 comments

Comments

@Mariatta
Copy link
Member

@Mariatta Mariatta commented Jun 11, 2019

In python-dev mailing list, it was asked what to do when a PR will address multiple issues.
https://mail.python.org/archives/list/[email protected]/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.

@tiran
Copy link
Member

@tiran tiran commented Jun 11, 2019

+1

I see "the oldest one" more like a guideline or preference than a hard rule. Sometimes there is another ticket with more or better information on the issue. It's a judgement call

@ncoghlan
Copy link
Contributor

@ncoghlan ncoghlan commented Jun 15, 2019

The other technique I've used is to keep the additional issue open, but have the associated PR be purely a docs change. That was for https://bugs.python.org/issue30661, where changing the default behaviour in the tarfile module also changed the default behaviour in shutil. It doesn't apply for pure bug fixes though - only cases that call for a versionchanged entry in the documentation.

That would make the two possible resolutions be:

  1. For multiple bug reports with a common underlying cause, choose the one that best reflects the underlying fault (often, but not always, the oldest one), mark the other issues as duplicates of that one, and then associate the PR and NEWS entry with the selected issue
  2. If it seems appropriate to have more than one NEWS entry for multiple affected APIs, then some of the issues may be converted to documentation issues rather than being closed as duplicates
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.