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.

Sign up for GitHub

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

Jump to bottom

Document auto-closing keywords for PRs. #855

Merged
merged 6 commits into from
Oct 7, 2022
Merged

Document auto-closing keywords for PRs. #855

Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
48ffd3b
Document auto-closing keywords for PRs.
ezio-melotti May 6, 2022
e8f7e6a
Merge branch 'main' into autoclosing-kws
ezio-melotti Jul 12, 2022
34d2080
Bedevere now adds the issue number in the body.
ezio-melotti Jul 12, 2022
7a799a2
Apply suggestions from code review
ezio-melotti Jul 13, 2022
a279ae1
Add a new entry about linking to issues/PRs.
ezio-melotti Aug 18, 2022
30b5f7d
Make sentence more explicit.
ezio-melotti Aug 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions getting-started/git-boot-camp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,15 @@ Creating a Pull Request

6. Press the ``Create pull request`` button.

You should include the issue number in the title of the PR,
in the format ``gh-NNNNN: <PR Title>``.

You might also use `special keywords
<https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword>`_
to automatically close the linked issue once the PR is merged. However, you
should avoid them if other PRs need to be merged before the issue can be
closed (e.g. backports to other branches).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For a new contributor, this might raise more questions than it answers. Can we link to a reference somewhere else in the devguide that tells contributors which PRs are generally backported, and which are not?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To note, there's also other benefits to linking a PR beyond just auto-close—most notably, it adds an easy to find reference to the PR from the issue and the issue from the PR a number of handy places in the GitHub UI, which make navigation a fair bit quicker than manually/semi-automatically trying to figure out the corresponding PR (or issue).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nearly all bug fixes, doc fixes, and IDLE changes are backported, and nearly all feature changes are not. But even feature issues may require multiple PRs, so the above advice is still incomplete. And there are PRs without an issue. By linking autoclose to linking of issue to PR, GH has made issue-PR linking worse than useless.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, unfortunately the story on GitHub around relationships of multiple PRs for one issue has never been good, and unlike a number of other pain points that have improved substantially in recent years, this one doesn't seem to have. And unlike UI issues, there's not as much Refined GitHub and tools like it can do about it—it is a big reason that GitHub overlays like ZenHub gained such a following

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unfortunately the story on GitHub around relationships of multiple PRs for one issue has never been good

I created this:

Copy link

@omerbensaadon omerbensaadon Sep 23, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hey folks, I've captured this feedback! I hope that [tasklists] can help make this experienc better in the future. keep it coming :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @omerbensaadon ! We all really appreciate it!


Updating your CPython Fork
--------------------------

Expand Down